bookclerk_plugin_abi::plugin_capnp::kv_namespace

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
GetParams type alias
GetResults type alias
PutParams type alias
PutResults type alias
DeleteParams type alias
DeleteResults type alias
ListParams type alias
ListResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn get(
        self: Rc<Self>,
        _: GetParams,
        _: GetResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn put(
        self: Rc<Self>,
        _: PutParams,
        _: PutResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn delete(
        self: Rc<Self>,
        _: DeleteParams,
        _: DeleteResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn list(
        self: Rc<Self>,
        _: ListParams,
        _: ListResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::get

fn get(
    self: Rc<Self>,
    _: GetParams,
    _: GetResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::put

fn put(
    self: Rc<Self>,
    _: PutParams,
    _: PutResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::delete

fn delete(
    self: Rc<Self>,
    _: DeleteParams,
    _: DeleteResults,
) -> 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::get_request

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

Client::put_request

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

Client::delete_request

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

GetParams

pub type GetParams = Params<Owned>;

GetResults

pub type GetResults = Results<Owned>;

PutParams

pub type PutParams = Params<Owned>;

PutResults

pub type PutResults = Results<Owned>;

DeleteParams

pub type DeleteParams = Params<Owned>;

DeleteResults

pub type DeleteResults = 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