bookclerk_plugin_abi::plugin_capnp::plugin_worker

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
DescribeParams type alias
DescribeResults type alias
OpenParams type alias
OpenResults type alias
ShutdownParams type alias
ShutdownResults type alias
DatabaseMigrationsParams type alias
DatabaseMigrationsResults type alias

Modules

Traits

Server

pub trait Server: 'static {
    fn describe(
        self: Rc<Self>,
        _: DescribeParams,
        _: DescribeResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn open(
        self: Rc<Self>,
        _: OpenParams,
        _: OpenResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn shutdown(
        self: Rc<Self>,
        _: ShutdownParams,
        _: ShutdownResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
    fn database_migrations(
        self: Rc<Self>,
        _: DatabaseMigrationsParams,
        _: DatabaseMigrationsResults,
    ) -> impl Future<Output = Result<(), Error>> + 'static;
}

Server::describe

fn describe(
    self: Rc<Self>,
    _: DescribeParams,
    _: DescribeResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::open

fn open(
    self: Rc<Self>,
    _: OpenParams,
    _: OpenResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::shutdown

fn shutdown(
    self: Rc<Self>,
    _: ShutdownParams,
    _: ShutdownResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Server::database_migrations

fn database_migrations(
    self: Rc<Self>,
    _: DatabaseMigrationsParams,
    _: DatabaseMigrationsResults,
) -> impl Future<Output = Result<(), Error>> + 'static

Implemented by: PluginServer

Structs

Client

pub struct Client {
    pub client: Client,
}

Client::describe_request

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

Client::open_request

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

Client::shutdown_request

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

Client::database_migrations_request

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

DescribeParams

pub type DescribeParams = Params<Owned>;

DescribeResults

pub type DescribeResults = Results<Owned>;

OpenParams

pub type OpenParams = Params<Owned>;

OpenResults

pub type OpenResults = Results<Owned>;

ShutdownParams

pub type ShutdownParams = Params<Owned>;

ShutdownResults

pub type ShutdownResults = Results<Owned>;

DatabaseMigrationsParams

pub type DatabaseMigrationsParams = Params<Owned>;

DatabaseMigrationsResults

pub type DatabaseMigrationsResults = Results<Owned>;

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