Struct BPlusTreeSet

pub struct BPlusTreeSet<K: Key> { /* private fields */ }

A B+ tree based set

Implementations

impl<K: Key> BPlusTreeSet<K>

pub fn new() -> Self

Create a new BPlusTreeSet

Examples

use sweep_bptree::BPlusTreeSet;

BPlusTreeSet::<i32>::new();

pub fn len(&self) -> usize

Returns key count in the set

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
assert_eq!(set.len(), 0);
set.insert(1);
assert_eq!(set.len(), 1);

set.insert(1);
assert_eq!(set.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the set contains no key

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
assert!(set.is_empty());

set.insert(1);
assert!(!set.is_empty());

pub fn insert(&mut self, k: K) -> bool

Insert a key into the set Returns true if the key was inserted, false if it already existed

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
assert!(set.insert(1));
assert!(!set.insert(1));

pub fn remove<Q>(&mut self, k: &Q) -> bool

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

Remove a key from the set Returns true if the key was removed, false if it didn’t exist

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
set.insert(1);
assert!(set.remove(&1));
assert!(!set.remove(&2));

pub fn contains<Q>(&self, k: &Q) -> bool

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

Returns true if the set contains the key

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
set.insert(1);
assert!(set.contains(&1));
set.remove(&1);
assert!(!set.contains(&1));

pub fn clear(&mut self)

Clears the set

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();
set.insert(1);
set.insert(2);

set.clear();
assert!(set.is_empty());

pub fn first(&self) -> Option<&K>

Returns a reference to the first key in the set, if any

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();

assert!(set.first().is_none());

set.insert(1);
set.insert(2);

assert_eq!(*set.first().unwrap(), 1);

pub fn last(&self) -> Option<&K>

Returns a reference to the last key in the set, if any

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();

assert!(set.last().is_none());

set.insert(1);
set.insert(2);

assert_eq!(*set.last().unwrap(), 2);

pub fn iter(&self) -> Iter<'_, K>

Returns a iterator over the keys in the set

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<i32>::new();

set.insert(1);
set.insert(2);

let keys = set.iter().collect::<Vec<_>>();
assert_eq!(keys.len(), 2);

pub fn into_iter(self) -> IntoIter<K>

Returns a iterator over the keys in the set

Examples

use sweep_bptree::BPlusTreeSet;

let mut set = BPlusTreeSet::<String>::new();

set.insert(1.to_string());
set.insert(2.to_string());

let keys = set.into_iter().collect::<Vec<_>>();
assert_eq!(keys.len(), 2);

pub fn union<'a>(&'a self, other: &'a Self) -> Union<'a, K>

Visits the elements representing the union, i.e., all the elements in self or other, without duplicates, in ascending order.

Examples

use sweep_bptree::BPlusTreeSet;

let mut a = BPlusTreeSet::new();
a.insert(1);

let mut b = BPlusTreeSet::new();
b.insert(1);
b.insert(2);

let union: Vec<_> = a.union(&b).cloned().collect();
assert_eq!(union, [1, 2]);

Trait Implementations

impl<K: Key> Default for BPlusTreeSet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Key> FromIterator<K> for BPlusTreeSet<K>

fn from_iter<T: IntoIterator<Item = K>>(iter: T) -> Self

Create a BPlusTreeSet from an iterator

Example

use sweep_bptree::BPlusTreeSet;

let set = BPlusTreeSet::<_>::from_iter(0..1000);
assert_eq!(set.len(), 1000);
assert!(set.contains(&1));