Struct Path

#[repr(transparent)]
pub struct Path<T: ?Sized, const S: char>(pub T);

Path with named keys separated by a separator char

The path will either be empty or start with the separator.

• path: T: A Write to write the separators and node names into during Transcode. See also TreeKey::traverse_all() and Metadata::max_length() for upper bounds on path length. Can also be a AsRef<str> to implement IntoKeys (see KeysIter).
• const S: char: The path hierarchy separator to be inserted before each name, e.g. '/'.

Tuple Fields

0: T

Implementations

impl<T: ?Sized, const S: char> Path<T, S>

pub const fn separator(&self) -> char

The path hierarchy separator

impl<T, const S: char> Path<T, S>

pub fn into_inner(self) -> T

Extract just the path

Trait Implementations

impl<T: Clone + ?Sized, const S: char> Clone for Path<T, S>

fn clone(&self) -> Path<T, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized, const S: char> Debug for Path<T, S>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized, const S: char> Default for Path<T, S>

fn default() -> Path<T, S>

Returns the “default value” for a type.

impl<T: ?Sized, const S: char> Deref for Path<T, S>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized, const S: char> DerefMut for Path<T, S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T, const S: char> Deserialize<'de> for Path<T, S>

where T: Deserialize<'de> + ?Sized,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, const S: char> From<T> for Path<T, S>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, T: AsRef<str> + ?Sized, const S: char> IntoKeys for &'a Path<T, S>

type IntoKeys = KeysIter<PathIter<'a, S>>

The specific Keys implementor.

fn into_keys(self) -> Self::IntoKeys

Convert self into a Keys implementor.

impl<'a, T: AsRef<str> + ?Sized, const S: char> IntoKeys for Path<&'a T, S>

type IntoKeys = KeysIter<PathIter<'a, S>>

The specific Keys implementor.

fn into_keys(self) -> Self::IntoKeys

Convert self into a Keys implementor.

impl<T: Ord + ?Sized, const S: char> Ord for Path<T, S>

fn cmp(&self, other: &Path<T, S>) -> 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<T: PartialEq + ?Sized, const S: char> PartialEq for Path<T, S>

fn eq(&self, other: &Path<T, S>) -> 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<T: PartialOrd + ?Sized, const S: char> PartialOrd for Path<T, S>

fn partial_cmp(&self, other: &Path<T, S>) -> 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<T, const S: char> Serialize for Path<T, S>

where T: Serialize + ?Sized,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Write + ?Sized, const S: char> Transcode for Path<T, S>

fn transcode<M, K>(&mut self, keys: K) -> Result<Node, Traversal>

where M: TreeKey + ?Sized, K: IntoKeys,

Perform a node lookup of a K: IntoKeys on a M: TreeKey<Y> and transcode it.

impl<T: Copy + ?Sized, const S: char> Copy for Path<T, S>

impl<T: Eq + ?Sized, const S: char> Eq for Path<T, S>

impl<T: ?Sized, const S: char> StructuralPartialEq for Path<T, S>