Struct orga::store::Shared

pub struct Shared<T>(_);

A shared reference to a store, allowing the store to be cloned and read from or written to by multiple consumers.

Shared has the Clone trait - it is safe to clone references to the store since get, put, and delete all operate atomically so there will never be more than one reference borrowing the underlying store at a time.

Implementations

impl<T> Shared<T>

pub fn new(inner: T) -> Self

Constructs a Shared by wrapping the given store.

Trait Implementations

impl<T> Clone for Shared<T>

fn clone(&self) -> Shared<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Read> Read for Shared<R>

fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Gets a value by key.

fn wrap<T: State<Self>>(self) -> Result<T>

Wraps self with a given state::State implementation, provided for convenience.

fn into_shared(self) -> Shared<Self>

Wraps self with Shared, allowing it to be cloned so that multiple callers can share the reference to the underlying store.

fn prefix(self, prefix: u8) -> Prefixed<Self>

Wraps self with Prefixed using the given prefix byte, so that all operations have the prefix prepended to their keys.

fn into_splitter(self) -> Splitter<Self>

Wraps self with Splitter so that prefixed substores may be created by calling .split().

fn as_ref<'a>(&'a self) -> &'a Self

Returns an immutable reference to the store.

impl<W: Write> Write for Shared<W>

fn put(&mut self, key: Vec<u8>, value: Vec<u8>) -> Result<()>

Writes a key and value to the store.

fn delete(&mut self, key: &[u8]) -> Result<()>

Deletes the value with the given key.

fn as_mut<'a>(&'a mut self) -> &'a mut Self

Returns a mutable reference to the store.