bookclerk_plugin_abi::plugin_capnp::event_publisher

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
PublishParams type alias
PublishResults type alias
ReadParams type alias
ReadResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn publish(
        self: Rc<Self>,
        _: PublishParams,
        _: PublishResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn read(
        self: Rc<Self>,
        _: ReadParams,
        _: ReadResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::publish

fn publish(
    self: Rc<Self>,
    _: PublishParams,
    _: PublishResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::read

fn read(
    self: Rc<Self>,
    _: ReadParams,
    _: ReadResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::publish_request

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

Client::read_request

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

PublishParams

pub type PublishParams = Params<Owned>;

PublishResults

pub type PublishResults = Results<Owned>;

ReadParams

pub type ReadParams = Params<Owned>;

ReadResults

pub type ReadResults = Results<Owned>;

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