Struct TrieMask

pub struct TrieMask(/* private fields */);

A struct representing a mask of 16 bits, used for Ethereum trie operations.

Masks in a trie are used to efficiently represent and manage information about the presence or absence of certain elements, such as child nodes, within a trie. Masks are usually implemented as bit vectors, where each bit represents the presence (1) or absence (0) of a corresponding element.

Implementations

impl TrieMask

pub const fn new(inner: u16) -> Self

Creates a new TrieMask from the given inner value.

pub const fn get(self) -> u16

Returns the inner value of the TrieMask.

pub const fn from_nibble(nibble: u8) -> Self

Creates a new TrieMask from the given nibble.

pub fn is_subset_of(self, other: Self) -> bool

Returns true if the current TrieMask is a subset of other.

pub const fn is_bit_set(self, index: u8) -> bool

Returns true if a given bit is set in a mask.

pub const fn is_empty(self) -> bool

Returns true if the mask is empty.

pub const fn count_bits(self) -> u8

Returns the number of bits set in the mask.

pub const fn first_set_bit_index(self) -> Option<u8>

Returns the index of the first bit set in the mask, or None if the mask is empty.

pub fn set_bit(&mut self, index: u8)

Set bit at a specified index.

pub fn unset_bit(&mut self, index: u8)

Unset bit at a specified index.

Methods from Deref<Target = u16>

pub const MIN: u16 = 0u16

pub const MAX: u16 = 65_535u16

pub const BITS: u32 = 16u32

Trait Implementations

impl BitAnd for TrieMask

type Output = TrieMask

The resulting type after applying the & operator.

fn bitand(self, rhs: TrieMask) -> TrieMask

Performs the & operation.

impl BitAndAssign for TrieMask

fn bitand_assign(&mut self, rhs: TrieMask)

Performs the &= operation.

impl BitOr for TrieMask

type Output = TrieMask

The resulting type after applying the | operator.

fn bitor(self, rhs: TrieMask) -> TrieMask

Performs the | operation.

impl BitOrAssign for TrieMask

fn bitor_assign(&mut self, rhs: TrieMask)

Performs the |= operation.

impl Clone for TrieMask

fn clone(&self) -> TrieMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrieMask

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

Formats the value using the given formatter.

impl Default for TrieMask

fn default() -> TrieMask

Returns the “default value” for a type.

impl Deref for TrieMask

type Target = u16

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<u16> for TrieMask

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Not for TrieMask

type Output = TrieMask

The resulting type after applying the ! operator.

fn not(self) -> TrieMask

Performs the unary ! operation.

impl Ord for TrieMask

fn cmp(&self, other: &TrieMask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TrieMask

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

fn partial_cmp(&self, other: &TrieMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TrieMask

impl Eq for TrieMask

impl StructuralPartialEq for TrieMask