Struct PrefixSetMut

pub struct PrefixSetMut { /* private fields */ }

A container for efficiently storing and checking for the presence of key prefixes.

This data structure stores a set of Nibbles and provides methods to insert new elements and check whether any existing element has a given prefix.

Internally, this implementation uses a Vec and aims to act like a BTreeSet in being both sorted and deduplicated. It does this by keeping a sorted flag. The sorted flag represents whether or not the Vec is definitely sorted. When a new element is added, it is set to false.. The Vec is sorted and deduplicated when sorted is true and:

• An element is being checked for inclusion (contains), or
• The set is being converted into an immutable PrefixSet (freeze)

This means that a PrefixSet will always be sorted and deduplicated when constructed from a PrefixSetMut.

Examples

use reth_trie_common::{prefix_set::PrefixSetMut, Nibbles};

let mut prefix_set_mut = PrefixSetMut::default();
prefix_set_mut.insert(Nibbles::from_nibbles_unchecked(&[0xa, 0xb]));
prefix_set_mut.insert(Nibbles::from_nibbles_unchecked(&[0xa, 0xb, 0xc]));
let mut prefix_set = prefix_set_mut.freeze();
assert!(prefix_set.contains(&[0xa, 0xb]));
assert!(prefix_set.contains(&[0xa, 0xb, 0xc]));

Implementations

impl PrefixSetMut

pub fn with_capacity(capacity: usize) -> Self

Create PrefixSetMut with pre-allocated capacity.

pub const fn all() -> Self

Create PrefixSetMut that considers all key changed.

pub fn insert(&mut self, nibbles: Nibbles)

Inserts the given nibbles into the set.

pub fn extend(&mut self, other: Self)

Extend prefix set with contents of another prefix set.

pub fn extend_keys<I>(&mut self, keys: I)

where I: IntoIterator<Item = Nibbles>,

Extend prefix set keys with contents of provided iterator.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn is_empty(&self) -> bool

Returns true if the set is empty.

pub fn freeze(self) -> PrefixSet

Returns a PrefixSet with the same elements as this set.

If not yet sorted, the elements will be sorted and deduplicated.

Trait Implementations

impl Clone for PrefixSetMut

fn clone(&self) -> PrefixSetMut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrefixSetMut

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

Formats the value using the given formatter.

impl Default for PrefixSetMut

fn default() -> PrefixSetMut

Returns the “default value” for a type.

impl<I> From<I> for PrefixSetMut

where I: IntoIterator<Item = Nibbles>,

fn from(value: I) -> Self

Converts to this type from the input type.

impl PartialEq for PrefixSetMut

fn eq(&self, other: &PrefixSetMut) -> 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 Eq for PrefixSetMut

impl StructuralPartialEq for PrefixSetMut

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes