Skip to main content

NodePath

Struct NodePath 

Source
pub struct NodePath<'a> { /* private fields */ }
Expand description

A borrowed node path: little-endian u16 components over the envelope’s own buffer.

Holding the raw bytes rather than a &[u16] avoids both an alignment requirement the envelope cannot guarantee and a copy the boundary does not need.

Implementations§

Source§

impl<'a> NodePath<'a>

Source

pub const fn from_le_bytes(bytes: &'a [u8]) -> Self

Wrap the little-endian component bytes of a path.

bytes.len() must be even; the decoder only ever produces such slices. An odd length drops the trailing half-component here, at construction, rather than at each read: a path whose byte count disagreed with its component count would encode a length prefix the decoder then uses to take fewer bytes than were written, shifting every field after it.

Source

pub const fn root() -> Self

The root node itself.

Source

pub const fn len(self) -> usize

Number of components.

Source

pub const fn is_empty(self) -> bool

Whether this path addresses the root node.

Source

pub fn get(self, index: usize) -> Option<u16>

The component at index, if present.

Source

pub fn iter(self) -> impl Iterator<Item = u16> + 'a

Iterate the components from the root downwards.

as_chunks yields fixed-size pairs, so decoding needs no fallible step and a trailing odd byte is simply not a component.

Source

pub const fn as_le_bytes(self) -> &'a [u8] ⓘ

The underlying little-endian bytes.

Source

pub fn starts_with(self, other: NodePath<'_>) -> bool

Whether self is other or a node beneath it.

Trait Implementations§

Source§

impl<'a> Clone for NodePath<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for NodePath<'a>

Source§

impl Debug for NodePath<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for NodePath<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for NodePath<'a>

Source§

impl<'a> Hash for NodePath<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> IntoIterator for NodePath<'a>

Source§

type Item = u16

The type of the elements being iterated over.
Source§

type IntoIter = Map<Copied<Iter<'a, [u8; 2]>>, fn([u8; 2]) -> u16>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a> PartialEq for NodePath<'a>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for NodePath<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for NodePath<'a>

§

impl<'a> RefUnwindSafe for NodePath<'a>

§

impl<'a> Send for NodePath<'a>

§

impl<'a> Sync for NodePath<'a>

§

impl<'a> Unpin for NodePath<'a>

§

impl<'a> UnsafeUnpin for NodePath<'a>

§

impl<'a> UnwindSafe for NodePath<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.