Struct nebari::TransactionTree

pub struct TransactionTree<Root: Root, File: ManagedFile> { /* private fields */ }

A tree that is modifiable during a transaction.

Implementations

impl<File: ManagedFile, Index> TransactionTree<VersionedTreeRoot<Index>, File> where
    Index: Clone + Reducer<Index> + EmbeddedIndex + Debug + 'static, 

pub fn current_sequence_id(&self) -> u64

Returns the latest sequence id.

impl<Root: Root, File: ManagedFile> TransactionTree<Root, File>

pub fn set(
    &mut self,
    key: impl Into<ArcBytes<'static>>,
    value: impl Into<ArcBytes<'static>>
) -> Result<(), Error>

Sets key to value.

pub fn modify<'a>(
    &mut self,
    keys: Vec<ArcBytes<'a>>,
    operation: Operation<'a, ArcBytes<'static>>
) -> Result<(), Error>

Executes a modification.

pub fn replace(
    &mut self,
    key: impl Into<ArcBytes<'static>>,
    value: impl Into<ArcBytes<'static>>
) -> Result<Option<ArcBytes<'static>>, Error>

Sets key to value. If a value already exists, it will be returned.

pub fn get(&mut self, key: &[u8]) -> Result<Option<ArcBytes<'static>>, Error>

Returns the current value of key. This will return updated information if it has been previously updated within this transaction.

pub fn remove(&mut self, key: &[u8]) -> Result<Option<ArcBytes<'static>>, Error>

Removes key and returns the existing value, if present.

pub fn compare_and_swap(
    &mut self,
    key: &[u8],
    old: Option<&ArcBytes<'_>>,
    new: Option<ArcBytes<'_>>
) -> Result<(), CompareAndSwapError>

Compares the value of key against old. If the values match, key will be set to the new value if new is Some or removed if new is None.

pub fn get_multiple(
    &mut self,
    keys: &[&[u8]]
) -> Result<Vec<(ArcBytes<'static>, ArcBytes<'static>)>, Error>

Retrieves the values of keys. If any keys are not found, they will be omitted from the results. Keys are required to be pre-sorted.

pub fn get_range<'keys, KeyRangeBounds>(
    &mut self,
    range: &'keys KeyRangeBounds
) -> Result<Vec<(ArcBytes<'static>, ArcBytes<'static>)>, Error> where
    KeyRangeBounds: RangeBounds<&'keys [u8]> + Debug + ?Sized, 

Retrieves all of the values of keys within range.

pub fn scan<'b, 'keys, CallerError, KeyRangeBounds, NodeEvaluator, KeyEvaluator, DataCallback>(
    &mut self,
    range: &'keys KeyRangeBounds,
    forwards: bool,
    node_evaluator: NodeEvaluator,
    key_evaluator: KeyEvaluator,
    callback: DataCallback
) -> Result<(), AbortError<CallerError>> where
    KeyRangeBounds: RangeBounds<&'keys [u8]> + Debug + ?Sized,
    NodeEvaluator: FnMut(&ArcBytes<'static>, &Root::ReducedIndex, usize) -> bool,
    KeyEvaluator: FnMut(&ArcBytes<'static>, &Root::Index) -> KeyEvaluation,
    DataCallback: FnMut(ArcBytes<'static>, &Root::Index, ArcBytes<'static>) -> Result<(), AbortError<CallerError>>,
    CallerError: Display + Debug, 

Scans the tree. Each key that is contained range will be passed to key_evaluator, which can opt to read the data for the key, skip, or stop scanning. If KeyEvaluation::ReadData is returned, callback will be invoked with the key and stored value. The order in which callback is invoked is not necessarily the same order in which the keys are found.

pub fn last_key(&mut self) -> Result<Option<ArcBytes<'static>>, Error>

Returns the last of the tree.

pub fn last(
    &mut self
) -> Result<Option<(ArcBytes<'static>, ArcBytes<'static>)>, Error>

Returns the last key and value of the tree.