Struct Docs

pub struct Docs<S> { /* private fields */ }

Available on crate feature engine only.

Docs protocol.

Implementations

impl Docs<()>

pub fn memory() -> Builder

Create a new Builder for the docs protocol, using in memory replica and author storage.

pub fn persistent(path: PathBuf) -> Builder

Create a new Builder for the docs protocol, using a persistent replica and author storage in the given directory.

impl<S: Store> Docs<S>

pub fn client(&self) -> &MemClient

Available on crate feature rpc only.

Get an in memory client to interact with the docs engine.

pub fn new(engine: Engine<S>) -> Self

Create a new docs protocol with the given engine.

Note that usually you would use the Builder to create a new docs protocol.

pub async fn handle_rpc_request<C: ChannelTypes<RpcService>>( self, msg: Request, chan: RpcChannel<RpcService, C>, ) -> Result<(), RpcServerError<C>>

Available on crate feature rpc only.

Handle a docs request from the RPC server.

pub fn protect_cb(&self) -> ProtectCb

Get the protect callback for the docs engine.

Trait Implementations

impl<S: Clone> Clone for Docs<S>

fn clone(&self) -> Docs<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Docs<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Store> ProtocolHandler for Docs<S>

fn accept(&self, conn: Connection) -> BoxedFuture<Result<()>>

Handle an incoming connection.

fn shutdown(&self) -> BoxedFuture<()>

Called when the node shuts down.

fn on_connecting( &self, connecting: Connecting, ) -> Pin<Box<dyn Future<Output = Result<Connection, Error>> + Send>>

Optional interception point to handle the Connecting state.