Struct PathComponent 

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

A single validated path component.

Guarantees: the inner string is a valid StructFS path component (UAX#31 identifier or pure numeric). Cannot be constructed from an arbitrary string without validation, which is what lets the path! macro accept PathComponent expressions without a runtime check.

Arbitrary strings

Real-world identifiers (my-account, hello world, UUIDs with dashes) are often not valid components. Use PathComponent::encode to embed them losslessly via Namecode and PathComponent::decode to recover the original string.

Implementations

impl PathComponent

pub fn try_new(s: impl Into<String>) -> Result<Self, PathError>

Validate and wrap a string as a path component.

pub fn encode(s: &str) -> Self

Encode an arbitrary string as a valid path component.

Valid UAX#31 identifiers pass through unchanged; everything else (punctuation, spaces, leading digits) is Namecode-encoded into a _N_-prefixed identifier. Always succeeds and is deterministic. Reverse with PathComponent::decode.

pub fn decode(&self) -> Result<String, PathError>

Decode a component produced by PathComponent::encode back to the original string.

Components that are not Namecode-encoded are returned unchanged (matching encode’s pass-through of valid identifiers). Returns an error only for a malformed _N_-prefixed component.

pub fn as_str(&self) -> &str

Get the validated string.

pub fn validated_str(&self) -> &str

Borrow the validated string.

Used by the path! macro to enforce that only PathComponent values (not bare String/&str) are accepted as runtime path components. Named distinctly so no standard type matches.

pub fn into_string(self) -> String

Consume and return the inner string.

Trait Implementations

impl AsRef<str> for PathComponent

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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<'de> Deserialize<'de> for PathComponent

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PathComponent

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

Formats the value using the given formatter.

impl Eq for PathComponent

impl From<PathComponent> for Path

fn from(c: PathComponent) -> Self

Converts to this type from the input type.

impl From<u64> for PathComponent

fn from(i: u64) -> Self

Converts to this type from the input type.

impl From<usize> for PathComponent

fn from(i: usize) -> Self

Converts to this type from the input type.

impl FromIterator<PathComponent> for Path

fn from_iter<I: IntoIterator<Item = PathComponent>>(iter: I) -> Self

Creates a value from an iterator.

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 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PathComponent

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

Equality operator ==.

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

Inequality operator !=.

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathComponent