Struct b_tree::BTree

pub struct BTree<S, C, G> { /* private fields */ }

A B+Tree

Implementations

impl<S, C, G> BTree<S, C, G>where S: Schema, C: Collate<Value = S::Value>,

pub fn schema(&self) -> &S

Borrow the Schema of this BTree.

impl<S, C, FE, G> BTree<S, C, G>where S: Schema, C: Collate<Value = S::Value>, FE: AsType<Node<Vec<Key<S::Value>>>> + Send + Sync, G: Deref<Target = Dir<FE>>, Node<Vec<Key<S::Value>>>: FileLoad + Debug,

pub async fn contains(&self, key: &Key<S::Value>) -> Result<bool, Error>

Return true if this B+Tree contains the given key.

pub async fn count(&self, range: &Range<S::Value>) -> Result<u64, Error>

Count how many keys lie within the given range of this B+Tree.

pub async fn first( &self, range: &Range<S::Value> ) -> Result<Option<Key<S::Value>>, Error>

Return the first key in this B+Tree within the given range, if any.

pub async fn last( &self, range: &Range<S::Value> ) -> Result<Option<Key<S::Value>>, Error>

Return the last key in this B+Tree with the given prefix, if any.

pub async fn is_empty(&self, range: &Range<S::Value>) -> Result<bool, Error>

Return true if the given range of this B+Tree contains zero keys.

pub fn nodes<'a>( &'a self, range: &'a Range<S::Value> ) -> impl Stream<Item = Result<FileReadGuardOwned<FE, [Key<S::Value>]>, Error>> + 'awhere FE: 'a,

Borrow all the keys in the given range of this B+Tree.

pub async fn is_valid(&self) -> Result<bool, Error>

impl<S, C, FE, G> BTree<S, C, G>where S: Schema, C: Collate<Value = S::Value> + Send + Sync + 'static, FE: AsType<Node<Vec<Key<S::Value>>>> + Send + Sync + 'static, G: Deref<Target = Dir<FE>> + Send + Sync + 'static, Node<Vec<Key<S::Value>>>: FileLoad + Debug,

pub fn keys<R: Into<Arc<Range<S::Value>>>>( self, range: R, reverse: bool ) -> impl Stream<Item = Result<Key<S::Value>, Error>> + Unpin + Send + Sized

Copy all the keys in the given range of this B+Tree.

impl<S, C, FE> BTree<S, C, DirWriteGuardOwned<FE>>

pub fn downgrade(self) -> BTreeReadGuard<S, C, FE>

Downgrade this BTreeWriteGuard into a BTreeReadGuard.

impl<S, C, FE> BTree<S, C, DirWriteGuardOwned<FE>>where S: Schema + Send + Sync, C: Collate<Value = S::Value> + Send + Sync, FE: AsType<Node<Vec<Key<S::Value>>>> + Send + Sync, Node<Vec<Key<S::Value>>>: FileLoad,

pub async fn delete(&mut self, key: &Key<S::Value>) -> Result<bool, S::Error>

Delete the given key from this B+Tree.

pub async fn insert(&mut self, key: Key<S::Value>) -> Result<bool, S::Error>

Insert the given key into this B+Tree. Return false if te given key is already present.

pub async fn truncate(&mut self) -> Result<(), Error>

Delete all the keys in this BTree.

impl<S, C, FE> BTree<S, C, DirWriteGuardOwned<FE>>where S: Schema + Send + Sync, C: Collate<Value = S::Value> + Send + Sync + 'static, FE: AsType<Node<Vec<Key<S::Value>>>> + Send + Sync + 'static, Node<Vec<Key<S::Value>>>: FileLoad,

pub async fn merge<G>(&mut self, other: BTree<S, C, G>) -> Result<(), S::Error>where G: Deref<Target = Dir<FE>> + Send + Sync + 'static,

Merge the keys from the other B+Tree range into this one.

The source B+Tree must have an identical schema and collation.

pub async fn delete_all<G>( &mut self, other: BTree<S, C, G> ) -> Result<(), S::Error>where G: Deref<Target = Dir<FE>> + Send + Sync + 'static,

Delete the keys in the other B+Tree from this one.

The source B+Tree must have an identical schema and collation.