bookclerk_plugin_abi::plugin_capnp::socket_handler

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
MessageParams type alias
MessageResults type alias
ClosedParams type alias
ClosedResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn message(
        self: Rc<Self>,
        _: MessageParams,
        _: MessageResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn closed(
        self: Rc<Self>,
        _: ClosedParams,
        _: ClosedResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::message

fn message(
    self: Rc<Self>,
    _: MessageParams,
    _: MessageResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::closed

fn closed(
    self: Rc<Self>,
    _: ClosedParams,
    _: ClosedResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::message_request

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

Client::closed_request

pub fn closed_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

MessageParams

pub type MessageParams = Params<Owned>;

MessageResults

pub type MessageResults = Results<Owned>;

ClosedParams

pub type ClosedParams = Params<Owned>;

ClosedResults

pub type ClosedResults = Results<Owned>;

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