Struct yadf::TreeBag

pub struct TreeBag<K, V>(/* private fields */);

Ordered counter structure.

Example :

use yadf::TreeBag;

let bag: TreeBag<i32, &str> = vec![
    (3, "hello world"),
    (3, "foobar"),
    (7, "fizz"),
    (7, "buzz"),
    (6, "rust"),
].into_iter().collect();

assert_eq!(bag[&3], ["hello world", "foobar"]);
assert_eq!(bag[&7], ["fizz", "buzz"]);
assert_eq!(bag[&6], ["rust"]);

Implementations

impl<K, V> TreeBag<K, V>

pub const fn duplicates(&self) -> Replicates<'_, K, V>

Provides a view only on the buckets containing more than one element.

pub const fn replicates(&self, factor: Factor) -> Replicates<'_, K, V>

Provides a view only on the buckets as constrained by the replication Factor.

pub const fn as_inner(&self) -> &BTreeMap<K, Vec<V>>

Borrows the backing BTreeMap of the bag.

pub fn as_inner_mut(&mut self) -> &mut BTreeMap<K, Vec<V>>

Mutably borrows the backing BTreeMap of the bag.

pub fn into_inner(self) -> BTreeMap<K, Vec<V>>

Consumes the wrapper TreeBag and returns the inner BTreeMap.

pub fn len(&self) -> usize

Returns the number of buckets in the bag.

pub fn is_empty(&self) -> bool

Returns true if the bag contains no elements.

pub fn get<Q>(&self, key: &Q) -> Option<&Vec<V>>

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

Returns a reference to the bucket corresponding to the key.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Vec<V>>

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

Returns a mutable reference to the bucket corresponding to the key.

pub fn entry(&mut self, key: K) -> Entry<'_, K, Vec<V>>

where K: Ord,

Gets the given key’s corresponding entry in the bag for in-place manipulation.

Trait Implementations

impl<K: Debug, V: Debug> Debug for TreeBag<K, V>

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

Formats the value using the given formatter.

impl<K, V> Default for TreeBag<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Ord, V> Extend<(K, V)> for TreeBag<K, V>

fn extend<I>(&mut self, key_value_iter: I)

where I: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<K, V> From<BTreeMap<K, Vec<V>>> for TreeBag<K, V>

fn from(btree: BTreeMap<K, Vec<V>>) -> Self

Build a TreeBag from a BTreeMap.

impl<K: Ord, V> FromIterator<(K, V)> for TreeBag<K, V>

fn from_iter<I>(key_value_iter: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<K, Q, V> Index<&Q> for TreeBag<K, V>

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

fn index(&self, key: &Q) -> &Self::Output

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the TreeBag.

type Output = Vec<V>

The returned type after indexing.

impl<K, V> Serialize for TreeBag<K, V>

where K: Serialize, V: Serialize,

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

where S: Serializer,

Serialize this value into the given Serde serializer.