Struct laminarmq::storage::commit_log::segmented_log::store::Store

pub struct Store<S, H> { /* private fields */ }

Unit of persistence within a Segment.

Fig: Segment diagram showing Store, persisting record bytes at positions mapped out by the Index records.

A Store contains a backing Storage impl instance to persist record bytes.

Implementations

impl<S, H> Store<S, H>

pub fn new(storage: S) -> Self

Creates a new Store instance from the given backing Storage instance.

impl<S, H> Store<S, H>

where S: Storage, H: Hasher + Default,

pub async fn read( &self, position: &S::Position, record_header: &RecordHeader ) -> Result<S::Content, StoreError<S::Error>>

Reads record bytes for a record persisted at the given position with the designated RecordHeader.

pub async fn append<XBuf, X, XE>( &mut self, stream: X, append_threshold: Option<S::Size> ) -> Result<(S::Position, RecordHeader), StoreError<S::Error>>

where XBuf: Deref<Target = [u8]>, X: Stream<Item = Result<XBuf, XE>> + Unpin,

Appends the bytes for a new record at the end of this store.

Returns the computed RecordHeader for the provided record bytes along with the position where the record was written.

Trait Implementations

impl<S: Storage, H> AsyncConsume for Store<S, H>

type ConsumeError = StoreError<<S as Storage>::Error>

Error that can occur during a consumption operation.

fn remove<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<(), Self::ConsumeError>> + 'async_trait>>

where Self: 'async_trait,

Removes all storage associated with this collection.

fn close<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<(), Self::ConsumeError>> + 'async_trait>>

where Self: 'async_trait,

Closes this collection.

impl<S: Storage, H> AsyncTruncate for Store<S, H>

type Mark = <S as AsyncTruncate>::Mark

Type to denote a truncation “mark”, after which the collection will be truncated.

type TruncError = StoreError<<S as Storage>::Error>

Error that can occur during a truncation operation.

fn truncate<'life0, 'life1, 'async_trait>( &'life0 mut self, pos: &'life1 Self::Mark ) -> Pin<Box<dyn Future<Output = Result<(), Self::TruncError>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Truncates this collection after the given mark, such that this collection contains records only upto this “mark”.

impl<S: Default, H> Default for Store<S, H>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Storage, H> Sizable for Store<S, H>

type Size = <S as Sizable>::Size

Type to represent the size of this collection in number of bytes.

fn size(&self) -> Self::Size

Returns the size of this collection in butes.