Struct Sequence 

pub struct Sequence<'db> { /* private fields */ }

A handle for manipulating a sequence record stored in a Database.

Multiple threads may share a single Sequence handle safely; all cache manipulation is protected by an internal Mutex. For higher throughput open separate handles to the same database key.

Example

use noxu_db::{SequenceConfig, DatabaseEntry};

let config = SequenceConfig::new().with_allow_create(true);
let key = DatabaseEntry::from_bytes(b"my_counter");
let seq = db.open_sequence(&key, config).unwrap();

let v1 = seq.get(None, 1).unwrap();
let v2 = seq.get(None, 1).unwrap();
assert_eq!(v2, v1 + 1);

Implementations

impl<'db> Sequence<'db>

pub fn get(&self, txn: Option<&Transaction>, delta: i32) -> Result<i64>

Returns the next available element in the sequence and advances by delta.

delta must be > 0 and must fit within the configured range.

The txn parameter, if provided, is used for the cache-refill database write, making it participate in the caller’s transaction. Sequence.get(Transaction txn, int delta).

pub fn get_stats(&self) -> SequenceStats

Returns a snapshot of statistics for this handle.

pub fn close(&self) -> Result<()>

Closes the sequence handle.

After calling this method the handle must not be used again. Unused cached values are discarded.