Struct mz_persist::client::RuntimeClient

pub struct RuntimeClient { /* private fields */ }

A clone-able handle to the persistence runtime.

The runtime is stopped when any client calls RuntimeClient::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 RuntimeClient

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

Synchronously registers a new stream for writes and reads.

This method is idempotent. Returns read and write handles used to construct a persisted stream operator.

TODO: This description seems outdated? Or at least only half true. If data was written by a previous RuntimeClient for this id, it’s loaded and replayed into the stream once constructed.

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, releasing exclusive-writer locks and causing all future commands to error.

This method is idempotent.

pub fn destroy(&mut self, id: &str) -> Result<bool, Error>

Synchronously remove the persisted stream.

This method is idempotent and returns true if the stream was actually destroyed, false if the stream had already been destroyed previously.

Trait Implementations

impl Clone for RuntimeClient

fn clone(&self) -> RuntimeClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeClient

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

Formats the value using the given formatter.

impl PartialEq<RuntimeClient> for RuntimeClient

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 RuntimeClient