bookclerk_plugin_abi::plugin_capnp::metadata_provider

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
HealthParams type alias
HealthResults type alias
LookupParams type alias
LookupResults type alias
SearchParams type alias
SearchResults type alias
ChaptersParams type alias
ChaptersResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn health(
        self: Rc<Self>,
        _: HealthParams,
        _: HealthResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn lookup(
        self: Rc<Self>,
        _: LookupParams,
        _: LookupResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn search(
        self: Rc<Self>,
        _: SearchParams,
        _: SearchResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn chapters(
        self: Rc<Self>,
        _: ChaptersParams,
        _: ChaptersResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::health

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

Server::lookup

fn lookup(
    self: Rc<Self>,
    _: LookupParams,
    _: LookupResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::search

fn search(
    self: Rc<Self>,
    _: SearchParams,
    _: SearchResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::chapters

fn chapters(
    self: Rc<Self>,
    _: ChaptersParams,
    _: ChaptersResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::health_request

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

Client::lookup_request

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

Client::search_request

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

Client::chapters_request

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

HealthParams

pub type HealthParams = Params<Owned>;

HealthResults

pub type HealthResults = Results<Owned>;

LookupParams

pub type LookupParams = Params<Owned>;

LookupResults

pub type LookupResults = Results<Owned>;

SearchParams

pub type SearchParams = Params<Owned>;

SearchResults

pub type SearchResults = Results<Owned>;

ChaptersParams

pub type ChaptersParams = Params<Owned>;

ChaptersResults

pub type ChaptersResults = Results<Owned>;

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