Struct Local 

pub struct Local<T> { /* private fields */ }

Durability implementation backed by a Commitlog on local storage.

The commitlog is constrained to store the canonical Txdata payload, where the generic parameter T is the type of the row data stored in the mutations section.

T is left generic in order to allow bypassing the ProductValue intermediate representation in the future.

Note, however, that instantiating T to a different type may require to change the log format version!

Implementations

impl<T: Encode + Send + Sync + 'static> Local<T>

pub fn open(root: CommitLogDir, rt: Handle, opts: Options) -> Result<Self>

Create a Local instance at the root directory.

The root directory must already exist.

Background tasks are spawned onto the provided tokio runtime.

pub fn queue_depth(&self) -> u64

Inspect how many transactions added via Self::append_tx are pending to be applied to the underlying Commitlog.

pub fn commits_from( &self, offset: TxOffset, ) -> impl Iterator<Item = Result<Commit, Traversal>>

Obtain an iterator over the Commits in the underlying log.

pub fn existing_segment_offsets(&self) -> Result<Vec<TxOffset>>

Get a list of segment offsets, sorted in ascending order.

pub fn compress_segments(&self, offsets: &[TxOffset]) -> Result<()>

Compress the segments at the offsets provided, marking them as immutable.

pub async fn close(self) -> Result<Option<TxOffset>>

Apply all outstanding transactions to the Commitlog and flush it to disk.

Returns the durable TxOffset, if any.

pub fn size_on_disk(&self) -> Result<u64>

Get the size on disk of the underlying Commitlog.

Trait Implementations

impl<T: Send + Sync + 'static> Durability for Local<T>

type TxData = Txdata<T>

The payload representing a single transaction.

fn append_tx(&self, tx: Self::TxData)

Submit the transaction payload to be made durable.

fn durable_tx_offset(&self) -> Option<TxOffset>

The TxOffset considered durable.

impl<T: Encode + 'static> History for Local<T>

type TxData = Txdata<T>

fn fold_transactions_from<D>( &self, offset: TxOffset, decoder: D, ) -> Result<(), D::Error>

where D: Decoder, D::Error: From<Traversal>,

Traverse the history of transactions from offset and “fold” it into the provided Decoder.

fn transactions_from<'a, D>( &self, offset: TxOffset, decoder: &'a D, ) -> impl Iterator<Item = Result<Transaction<Self::TxData>, D::Error>>

where D: Decoder<Record = Self::TxData>, D::Error: From<Traversal>, Self::TxData: 'a,

Obtain an iterator over the history of transactions, starting from offset.

fn tx_range_hint(&self) -> (TxOffset, Option<TxOffset>)

Get the maximum transaction offset contained in this history.