Struct ax_banyan::StreamBuilder

pub struct StreamBuilder<T: TreeTypes, V> { /* private fields */ }

A builder for a stream of trees

Most of the logic except for handling the empty case is implemented in the forest

Implementations

impl<T: TreeTypes, V> StreamBuilder<T, V>

pub fn new(config: Config, secrets: Secrets) -> Self

pub fn debug() -> Self

Creates a stream builder with debug settings.

The tree config will be the debug config that produces “interesting” trees even with a small number of elements.

The secrets will be the default secrets

Do not use this in production!

pub fn snapshot(&self) -> Tree<T, V>

pub fn link(&self) -> Option<T::Link>

pub fn as_index_ref(&self) -> Option<&Index<T>>

pub fn level(&self) -> i32

pub fn is_empty(&self) -> bool

true for an empty tree

pub fn count(&self) -> u64

number of elements in the tree

pub fn root(&self) -> Option<&T::Link>

root of a non-empty tree

pub fn index(&self) -> Option<&Index<T>>

root of a non-empty tree

pub fn transaction(&mut self) -> StreamTransaction<'_, T, V>

Modify a StreamBuilder and roll back the changes if the operation was not successful

Note that consumed offets are not rolled back to make sure we don’t reuse offsets.

Trait Implementations

impl<T: TreeTypes, V> Debug for StreamBuilder<T, V>

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

Formats the value using the given formatter.

impl<T: TreeTypes, V> Display for StreamBuilder<T, V>

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

Formats the value using the given formatter.