Struct Ordinal 

pub struct Ordinal<E: Context, V: CodecFixed<Cfg = ()>>(/* private fields */);

Implementation of Ordinal.

Mutating functions consume the store and return it only on success: an error (or a dropped future) destroys the handle.

Implementations

impl<E: Context, V: CodecFixed<Cfg = ()>> Ordinal<E, V>

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

Initialize a new Ordinal instance with a collection of BitMaps (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 BitMap is provided for a section, all records in that section are considered available if and only if the BitMap is set for the record. If a section is provided but no BitMap is populated, all records in that section are considered available.

Passing Some(BTreeMap::new()) or None removes all stored sections and starts empty.

pub async fn put(self, index: u64, value: V) -> Result<Self, 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 ranges(&self) -> impl Iterator<Item = (u64, u64)> + '_

Get an iterator over all ranges in the Ordinal.

pub fn ranges_from(&self, from: u64) -> impl Iterator<Item = (u64, u64)> + '_

Get an iterator over ranges that overlap or follow from.

pub fn first_index(&self) -> Option<u64>

Retrieve the first index in the Ordinal.

pub fn last_index(&self) -> Option<u64>

Retrieve the last index in the Ordinal.

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

Returns up to max missing items starting from start.

This method iterates through gaps between existing ranges, collecting missing indices until either max items are found or there are no more gaps to fill.

pub async fn prune(self, min: u64) -> Result<Self, 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(self) -> Result<Self, Error>

Write all pending entries and sync all modified Blobs.

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

Destroy Ordinal and remove all data.

Trait Implementations

impl<E: Context, V: CodecFixed<Cfg = ()>> Debug for Ordinal<E, V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.