Struct BTree 

pub struct BTree<TKey, TValue, TConfig>
where
    TKey: Ord,
    TConfig: BTreeConfig,
{ /* private fields */ }

The main data structure for the B-tree algorithm.

Implementations

impl<TKey, TValue, TConfig> BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

pub fn new() -> Self

where TConfig: Default,

Creates a new BTree with the default configuration.

Note: this method doesn’t allocate anything.

pub fn with_config(config: TConfig) -> Self

Creates a new BTree with the specified configuration.

Note: this method doesn’t allocate anything.

pub const fn len(&self) -> Length

Returns the number of key-value pairs in the BTree.

impl<TKey, TValue, TConfig> BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

pub fn try_insert_or_update( &mut self, key: TKey, adder: impl FnOnce() -> TValue, updater: impl FnOnce(&mut TValue), ) -> Result<&mut TValue, BTreeError>

Inserts a (key, adder()) pair into the tree if it doesn’t exist, or updates the value with update(value) call.

Notes

• If the key already exists, then this method discards key.
• This method guarantees that either adder or updater will be called, but not both.

Errors

See BTreeError for details.

pub fn try_insert( &mut self, key: TKey, value: TValue, ) -> Result<Option<TValue>, BTreeError>

Inserts a (key, value) pair into the tree.

Returns None if the key was not already present, or the previous value if it was.

Notes

This method discards key if it already exists.

Errors

See BTreeError for details.

impl<TKey, TValue, TConfig> BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

pub fn iter(&self) -> impl Iterator<Item = KVP<&TKey, &TValue>>

Iterates over the tree in ascending order.

pub fn iter_mut(&mut self) -> impl Iterator<Item = KVP<&TKey, &mut TValue>>

Iterates over the tree in ascending order.

impl<TKey, TValue, TConfig> BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

pub fn remove<Q>(&mut self, key: &Q) -> Option<KVP<TKey, TValue>>

where TKey: Borrow<Q>, Q: Ord + ?Sized,

Removes a key-value pair from the BTree.

Returns the removed key-value pair if the key was present, otherwise None.

impl<TKey, TValue, TConfig> BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

pub fn get<Q>(&self, key: &Q) -> Option<KVP<&TKey, &TValue>>

where TKey: Borrow<Q>, Q: Ord + ?Sized,

Returns the key-value pair with key matching the given key. Return None if the key is not present in the BTree.

Trait Implementations

impl<TKey, TValue, TConfig> Clone for BTree<TKey, TValue, TConfig>

where TKey: Ord + TryClone, TValue: TryClone, TConfig: BTreeConfig + TryClone,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TKey, TValue: Debug, TConfig> Debug for BTree<TKey, TValue, TConfig>

where TKey: Ord + Debug, TConfig: BTreeConfig + Debug,

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

Formats the value using the given formatter.

impl<TKey, TValue, TConfig> Default for BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, TKey, TValue, TConfig> Deserialize<'de> for BTree<TKey, TValue, TConfig>

where TKey: Ord + Deserialize<'de>, TValue: Deserialize<'de>, TConfig: BTreeConfig + Default,

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TKey, TValue, TConfig> Drop for BTree<TKey, TValue, TConfig>

where TKey: Ord, TConfig: BTreeConfig,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<TKey, TValue, TConfig> Eq for BTree<TKey, TValue, TConfig>

where TKey: Ord, TValue: Eq, TConfig: BTreeConfig,

impl<TKey, TValue, TConfig> Hash for BTree<TKey, TValue, TConfig>

where TKey: Ord + Hash, TValue: Hash, TConfig: BTreeConfig,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<TKey, TValue, TConfig> PartialEq for BTree<TKey, TValue, TConfig>

where TKey: Ord, TValue: PartialEq, TConfig: BTreeConfig,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TKey, TValue, TConfig> ReprC for BTree<TKey, TValue, TConfig>

where TKey: Ord + ReprC, TValue: ReprC, TConfig: BTreeConfig,

const CHECK: ()

This field is used for const checks only.

impl<TKey, TValue, TConfig> Send for BTree<TKey, TValue, TConfig>

where TKey: Ord + Send, TValue: Send, TConfig: BTreeConfig + Send,

impl<TKey, TValue, TConfig> Serialize for BTree<TKey, TValue, TConfig>

where TKey: Ord + Serialize, TValue: Serialize, TConfig: BTreeConfig,

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<TKey, TValue, TConfig> Sync for BTree<TKey, TValue, TConfig>

where TKey: Ord + Sync, TValue: Sync, TConfig: BTreeConfig + Sync,

impl<TKey, TValue, TConfig> TryClone for BTree<TKey, TValue, TConfig>

where TKey: Ord + TryClone, TValue: TryClone, TConfig: BTreeConfig + TryClone,

type Error = BTreeTryCloneError

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.