bookclerk_plugin_abi::plugin_capnp::remote_library

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
StartParams type alias
StartResults type alias
StopParams type alias
StopResults type alias
DiagnoseParams type alias
DiagnoseResults type alias
ScanLibraryParams type alias
ScanLibraryResults type alias
SyncListeningParams type alias
SyncListeningResults type alias
PollEventsParams type alias
PollEventsResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn health(
        self: Rc<Self>,
        _: HealthParams,
        _: HealthResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn start(
        self: Rc<Self>,
        _: StartParams,
        _: StartResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn stop(
        self: Rc<Self>,
        _: StopParams,
        _: StopResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn diagnose(
        self: Rc<Self>,
        _: DiagnoseParams,
        _: DiagnoseResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn scan_library(
        self: Rc<Self>,
        _: ScanLibraryParams,
        _: ScanLibraryResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn sync_listening(
        self: Rc<Self>,
        _: SyncListeningParams,
        _: SyncListeningResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn poll_events(
        self: Rc<Self>,
        _: PollEventsParams,
        _: PollEventsResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::health

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

Server::start

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

Server::stop

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

Server::diagnose

fn diagnose(
    self: Rc<Self>,
    _: DiagnoseParams,
    _: DiagnoseResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::scan_library

fn scan_library(
    self: Rc<Self>,
    _: ScanLibraryParams,
    _: ScanLibraryResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::sync_listening

fn sync_listening(
    self: Rc<Self>,
    _: SyncListeningParams,
    _: SyncListeningResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::poll_events

fn poll_events(
    self: Rc<Self>,
    _: PollEventsParams,
    _: PollEventsResults,
) -> 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::start_request

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

Client::stop_request

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

Client::diagnose_request

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

Client::scan_library_request

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

Client::sync_listening_request

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

Client::poll_events_request

pub fn poll_events_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>;

StartParams

pub type StartParams = Params<Owned>;

StartResults

pub type StartResults = Results<Owned>;

StopParams

pub type StopParams = Params<Owned>;

StopResults

pub type StopResults = Results<Owned>;

DiagnoseParams

pub type DiagnoseParams = Params<Owned>;

DiagnoseResults

pub type DiagnoseResults = Results<Owned>;

ScanLibraryParams

pub type ScanLibraryParams = Params<Owned>;

ScanLibraryResults

pub type ScanLibraryResults = Results<Owned>;

SyncListeningParams

pub type SyncListeningParams = Params<Owned>;

SyncListeningResults

pub type SyncListeningResults = Results<Owned>;

PollEventsParams

pub type PollEventsParams = Params<Owned>;

PollEventsResults

pub type PollEventsResults = Results<Owned>;

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