bookclerk_plugin_abi::plugin_capnp::plugin_cli

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Item Kind Summary
Server trait
Client struct
Owned struct
ServerDispatch struct
DescribeParams type alias
DescribeResults type alias
InvokeParams type alias
InvokeResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn describe(
        self: Rc<Self>,
        _: DescribeParams,
        _: DescribeResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn invoke(
        self: Rc<Self>,
        _: InvokeParams,
        _: InvokeResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::describe

fn describe(
    self: Rc<Self>,
    _: DescribeParams,
    _: DescribeResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::invoke

fn invoke(
    self: Rc<Self>,
    _: InvokeParams,
    _: InvokeResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::describe_request

pub fn describe_request(&self) -> Request<Owned, Owned>

Client::invoke_request

pub fn invoke_request(&self) -> Request<Owned, Owned>

Implements: Clone, FromClientHook, FromPointerBuilder<'a>, FromPointerReader<'a>, FromServer<_S>, HasTypeId, SetterInput<Owned>

Owned

pub struct Owned(/* private */);

Implements: Clone, Copy, Introspect, Owned, Pipelined, SetterInput<Owned>

ServerDispatch

pub struct ServerDispatch<_T> {
    pub server: Rc<_T>,
}

ServerDispatch::dispatch_call_internal

pub fn dispatch_call_internal(
    this: Rc<_T>,
    method_id: u16,
    params: Params<Owned>,
    results: Results<Owned>,
) -> DispatchCallResult

Implements: Clone, Deref, Server

Type aliases

DescribeParams

pub type DescribeParams = Params<Owned>;

DescribeResults

pub type DescribeResults = Results<Owned>;

InvokeParams

pub type InvokeParams = Params<Owned>;

InvokeResults

pub type InvokeResults = Results<Owned>;

Generated from crates/bookclerk-plugin-abi at main · View as Markdown