Struct Ordinal 

pub struct Ordinal<E: Storage + Metrics + Clock, V: CodecFixed<Cfg = ()>> { /* private fields */ }

Implementation of Ordinal.

Implementations

impl<E: Storage + Metrics + Clock, V: CodecFixed<Cfg = ()>> Ordinal<E, V>

pub async fn init(context: E, config: Config) -> Result<Self, Error>

Initialize a new Ordinal instance.

pub async fn init_with_bits( context: E, config: Config, bits: Option<BTreeMap<u64, &Option<BitVec>>>, ) -> Result<Self, Error>

Initialize a new Ordinal instance with a collection of BitVecs (indicating which records should be considered available).

If a section is not provided in the BTreeMap, all records in that section are considered unavailable. If a BitVec is provided for a section, all records in that section are considered available if and only if the BitVec is set for the record. If a section is provided but no BitVec is populated, all records in that section are considered available.

pub async fn put(&mut self, index: u64, value: V) -> Result<(), Error>

Add a value at the specified index (pending until sync).

pub async fn get(&self, index: u64) -> Result<Option<V>, Error>

Get the value for a given index.

pub fn has(&self, index: u64) -> bool

Check if an index exists.

pub fn next_gap(&self, index: u64) -> (Option<u64>, Option<u64>)

Get the next gap information for backfill operations.

pub fn missing_items(&self, start: u64, max: usize) -> Vec<u64>

Get up to the next max missing items after start.

pub async fn prune(&mut self, min: u64) -> Result<(), Error>

Prune indices older than min by removing entire blobs.

Pruning is done at blob boundaries to avoid partial deletions. A blob is pruned only if all possible indices in that blob are less than min.

pub async fn sync(&mut self) -> Result<(), Error>

Write all pending entries and sync all modified Blobs.

pub async fn close(self) -> Result<(), Error>

Sync all pending entries and Blobs.

pub async fn destroy(self) -> Result<(), Error>

Destroy Ordinal and remove all data.