Struct growthring::wal::WALWriter

pub struct WALWriter<F: WALStore> { /* fields omitted */ }

Implementations

impl<F: WALStore> WALWriter<F>

pub fn grow<'a, R: Record + 'a>(
    &'a mut self,
    records: Vec<R>
) -> Vec<impl Future<Output = Result<(R, WALRingId), ()>> + 'a>

Submit a sequence of records to WAL. It returns a vector of futures, each of which corresponds to one record. When a future resolves to WALRingId, it is guaranteed the record is already logged. Then, after finalizing the changes encoded by that record to the persistent storage, the caller can recycle the WAL files by invoking the given peel with the given WALRingIds. Note: each serialized record should contain at least 1 byte (empty record payload will result in assertion failure).

pub fn peel<'a, T: AsRef<[WALRingId]>>(
    &'a mut self,
    records: T
) -> impl Future<Output = Result<(), ()>> + 'a

Inform the WALWriter that some data writes are complete so that it could automatically remove obsolete WAL files. The given list of WALRingId does not need to be ordered and could be of arbitrary length.

pub fn file_pool_in_use(&self) -> usize

Trait Implementations

impl<F> Send for WALWriter<F> where
    F: WALStore + Send,