Skip to main content

DocumentFacade

forge_workspace::mcp::documents::facade

Trait DocumentFacade 

Source 
pub trait DocumentFacade: Send + Sync {
    // Required method
    fn hand_off<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        seat: &'life1 SessionSlot,
        path: &'life2 str,
        reviewable: bool,
    ) -> Pin<Box<dyn Future<Output = Result<(String, DocumentHandOffEnding), String>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
}
Expand description

The hand-off, as one tool call sees it.

Required Methods§

Source

fn hand_off<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, seat: &'life1 SessionSlot, path: &'life2 str, reviewable: bool, ) -> Pin<Box<dyn Future<Output = Result<(String, DocumentHandOffEnding), String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Read the document out of seat’s own tree or its project’s document_roots, ask the clients drawing that seat to open it, and park until the reader answers - answering with the resolved path and the ending the park released on.

A refused read raises nothing and parks on nothing; a forge with no attached client is the read’s sibling failure, its own sentence.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§