Struct LevelMask 

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

de Brujn level presence bitset.

Implementations

impl LevelMask

pub const EMPTY: Self

Empty bitset.

pub const MAX_LEVEL: u8 = 3

Max de Brujn level.

pub const fn new(mask: u8) -> Self

Constructs a new level mask, truncating extra bits.

pub const fn is_empty(self) -> bool

Returns true if there are no levels in mask.

pub const unsafe fn new_unchecked(mask: u8) -> Self

Constructs a new level mask from the provided byte as is.

Safety

The following must be true:

• Mask must be in range 0b000..=0b111.

pub const fn from_level(level: u8) -> Self

Creates a sufficient mask for the specified level.

NOTE: levels > 3 has no effect (mask will always be 0b111).

pub const fn level(self) -> u8

Counts presented higher hashes.

pub const fn hash_index(self, level: u8) -> u8

Computes hash index for the specified level.

pub const fn contains(self, level: u8) -> bool

Returns whether the specified level is included into the mask.

pub const fn virtualize(self, offset: u8) -> Self

Creates a new mask, shifted by the offset.

pub const fn to_byte(self) -> u8

Encodes level mask as byte.

Trait Implementations

impl BitOr for LevelMask

type Output = LevelMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for LevelMask

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for LevelMask

fn clone(&self) -> LevelMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LevelMask

impl Debug for LevelMask

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

Formats the value using the given formatter.

impl Eq for LevelMask

impl From<LevelMask> for u8

fn from(m: LevelMask) -> u8

Converts to this type from the input type.

impl Hash for LevelMask

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 IntoIterator for LevelMask

type Item = u8

The type of the elements being iterated over.

type IntoIter = LevelMaskIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for LevelMask

fn eq(&self, other: &LevelMask) -> 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 PartialEq<u8> for LevelMask

fn eq(&self, other: &u8) -> 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 StructuralPartialEq for LevelMask