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<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.

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 ranges(&self) -> impl Iterator<Item = (u64, u64)> + '_

Get an iterator over all ranges in the Ordinal.

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(&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.

Trait Implementations

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

type Key = u64

type Value = V

type Error = Error

async fn get(&self, key: &Self::Key) -> Result<Option<Self::Value>, Self::Error>

Get the value of a key.

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

async fn update( &mut self, key: Self::Key, value: Self::Value, ) -> Result<(), Self::Error>

Update the value of a key.

fn upsert( &mut self, key: Self::Key, update: impl FnOnce(&mut Self::Value), ) -> impl Future<Output = Result<(), Self::Error>>

where Self::Value: Default,

Updates the value associated with the given key in the store, inserting a default value if the key does not already exist.

fn create( &mut self, key: Self::Key, value: Self::Value, ) -> impl Future<Output = Result<bool, Self::Error>>

Creates a new key-value pair in the db. Returns true if the key was created, false if it already existed.

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

async fn commit(&mut self) -> Result<(), Self::Error>

Commit the store to disk, ensuring all changes are durably persisted.

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

Destroy the store, removing all persisted data.