bookclerk_plugin_abi::plugin_capnp::ingress

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
StartParams type alias
StartResults type alias
HealthParams type alias
HealthResults type alias
StopParams type alias
StopResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn start(
        self: Rc<Self>,
        _: StartParams,
        _: StartResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn health(
        self: Rc<Self>,
        _: HealthParams,
        _: HealthResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn stop(
        self: Rc<Self>,
        _: StopParams,
        _: StopResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::start

fn start(
    self: Rc<Self>,
    _: StartParams,
    _: StartResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::health

fn health(
    self: Rc<Self>,
    _: HealthParams,
    _: HealthResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::stop

fn stop(
    self: Rc<Self>,
    _: StopParams,
    _: StopResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::start_request

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

Client::health_request

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

Client::stop_request

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

StartParams

pub type StartParams = Params<Owned>;

StartResults

pub type StartResults = Results<Owned>;

HealthParams

pub type HealthParams = Params<Owned>;

HealthResults

pub type HealthResults = Results<Owned>;

StopParams

pub type StopParams = Params<Owned>;

StopResults

pub type StopResults = Results<Owned>;

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