Struct mz_persist::client::RuntimeReadClient

pub struct RuntimeReadClient { /* private fields */ }

A clone-able handle to the read-only persistence runtime.

The runtime is stopped when any client calls RuntimeReadClient::stop or when all clients have been dropped, whichever comes first.

NB: The methods below are executed concurrently. For a some call X to be guaranteed as “previous” to another call Y, X’s future must have been received before Y’s call started (though X’s future doesn’t need to have resolved).

Implementations

impl RuntimeReadClient

pub fn load<K: Codec, V: Codec>(&self, name: &str) -> StreamReadHandle<K, V>

Synchronously loads a stream for reads.

pub fn get_description(&self, name: &str) -> Result<StreamDesc, Error>

Returns a StreamDesc of the stream identified by name.

pub fn stop(&mut self) -> Result<(), Error>

Synchronously closes the runtime, causing all future commands to error.

This method is idempotent.

Trait Implementations

impl Clone for RuntimeReadClient

fn clone(&self) -> RuntimeReadClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeReadClient

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

Formats the value using the given formatter.

impl PartialEq<RuntimeReadClient> for RuntimeReadClient

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for RuntimeReadClient