Struct PathComponent 

pub struct PathComponent(pub U4);

A path component in a hexary trie; which is only 4 bits (aka a nibble).

Tuple Fields

0: U4

Implementations

impl PathComponent

pub const ALL: [Self; 16]

All possible path components.

This makes it easy to iterate over all possible children of a branch in a type-safe way. It is preferrable to do:

for (idx, slot) in PathComponent::ALL.into_iter().zip(branch.children.each_ref()) {
    /// use idx and slot
}

instead of using a raw range like (0..16) or Iterator::enumerate, which does not give a type-safe path component.

pub const LEN: usize = 16

The number of possible path components.

impl PathComponent

pub const fn as_u8(self) -> u8

Returns the path component as a u8.

pub const fn as_usize(self) -> usize

Returns the path component as a usize.

pub const fn try_new(value: u8) -> Option<Self>

Tries to create a path component from the given u8.

For hexary tries, the input must be in the range 0x00 to 0x0F inclusive. Any value outside this range will result in None.

For 256-ary tries, any value is valid.

pub const fn new_pair(v: u8) -> (Self, Self)

Creates a pair of path components from a single byte where the upper 4 bits are the first component and the lower 4 bits are the second component.

pub const fn join(self, other: Self) -> u8

Joins this PathComponent with another to create a single u8 where this component is the upper 4 bits and the provided component is the lower 4 bits.

Trait Implementations

impl Binary for PathComponent

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

Formats the value using the given formatter.

impl Clone for PathComponent

fn clone(&self) -> PathComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathComponent

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

Formats the value using the given formatter.

impl Display for PathComponent

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

Formats the value using the given formatter.

impl Extend<PathComponent> for PathGuard<'_>

fn extend<T: IntoIterator<Item = PathComponent>>(&mut self, iter: T)

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 Hash for PathComponent

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<T> Index<PathComponent> for Children<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<PathComponent> for Children<T>

fn index_mut(&mut self, index: PathComponent) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl LowerHex for PathComponent

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

Formats the value using the given formatter.

impl Ord for PathComponent

fn cmp(&self, other: &PathComponent) -> 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 PathComponent

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

fn partial_cmp(&self, other: &PathComponent) -> 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 TriePath for PathComponent

type Components<'a> = IntoIter<PathComponent> where Self: 'a

The iterator returned by TriePath::components.

fn len(&self) -> usize

The length, in path components, of this path.

fn components(&self) -> Self::Components<'_>

Returns an iterator over the components of this path.

fn as_component_slice(&self) -> PartialPath<'_>

Returns a contiguous view of this path’s components.

fn is_empty(&self) -> bool

Returns true if this path is empty (i.e. has length 0).

fn append<S>(self, suffix: S) -> JoinedPath<Self, S>

where Self: Sized, S: TriePath,

Appends the provided path segment to this path, returning a new joined path that represents the concatenation of the two paths.

fn prepend<P>(self, prefix: P) -> JoinedPath<P, Self>

where Self: Sized, P: TriePath,

Prepends the provided path segment to this path, returning a new joined path that represents the concatenation of the two paths.

fn path_eq<T: TriePath + ?Sized>(&self, other: &T) -> bool

Compares this path against another path for equality using path component equality.

fn path_cmp<T: TriePath + ?Sized>(&self, other: &T) -> Ordering

Compares this path against another path using path-component lexicographic ordering. Strict prefixes are less than their longer counterparts.

fn display(&self) -> DisplayPath<'_, Self>

Returns a wrapper type that implements std::fmt::Display and std::fmt::Debug for this path.

impl UpperHex for PathComponent

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

Formats the value using the given formatter.

impl Copy for PathComponent

impl Eq for PathComponent

impl StructuralPartialEq for PathComponent