bookclerk_plugin_abi::plugin_capnp::sockets

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
ConnectParams type alias
ConnectResults type alias
SendParams type alias
SendResults type alias
CloseParams type alias
CloseResults type alias
SetAttachmentParams type alias
SetAttachmentResults type alias
ListParams type alias
ListResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn connect(
        self: Rc<Self>,
        _: ConnectParams,
        _: ConnectResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn send(
        self: Rc<Self>,
        _: SendParams,
        _: SendResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn close(
        self: Rc<Self>,
        _: CloseParams,
        _: CloseResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn set_attachment(
        self: Rc<Self>,
        _: SetAttachmentParams,
        _: SetAttachmentResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn list(
        self: Rc<Self>,
        _: ListParams,
        _: ListResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::connect

fn connect(
    self: Rc<Self>,
    _: ConnectParams,
    _: ConnectResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::send

fn send(
    self: Rc<Self>,
    _: SendParams,
    _: SendResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::close

fn close(
    self: Rc<Self>,
    _: CloseParams,
    _: CloseResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::set_attachment

fn set_attachment(
    self: Rc<Self>,
    _: SetAttachmentParams,
    _: SetAttachmentResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::list

fn list(
    self: Rc<Self>,
    _: ListParams,
    _: ListResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::connect_request

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

Client::send_request

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

Client::close_request

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

Client::set_attachment_request

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

Client::list_request

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

ConnectParams

pub type ConnectParams = Params<Owned>;

ConnectResults

pub type ConnectResults = Results<Owned>;

SendParams

pub type SendParams = Params<Owned>;

SendResults

pub type SendResults = Results<Owned>;

CloseParams

pub type CloseParams = Params<Owned>;

CloseResults

pub type CloseResults = Results<Owned>;

SetAttachmentParams

pub type SetAttachmentParams = Params<Owned>;

SetAttachmentResults

pub type SetAttachmentResults = Results<Owned>;

ListParams

pub type ListParams = Params<Owned>;

ListResults

pub type ListResults = Results<Owned>;

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