Struct Path 

pub struct Path { /* private fields */ }

A borrowed, validated path for hierarchical document access.

Path is the borrowed counterpart to PathBuf, similar to how &str relates to String. It provides efficient read-only access to path components without allocation.

This type is unsized and must always be used behind a reference.

Implementations

impl Path

pub fn new(s: &str) -> &Path

Creates a Path from a string slice.

This is a zero-cost operation that wraps the string without validation or normalization. Normalization happens during path processing operations when needed.

This follows the same pattern as std::path::Path::new().

pub unsafe fn from_str_unchecked(s: &str) -> &Path

Creates a Path from a string without validation.

Safety

The caller must ensure that the string is a valid path according to our validation rules:

• No leading or trailing dots
• No empty components (consecutive dots)
• Components may not contain dots

This is primarily intended for use with compile-time validated string literals.

pub fn components(&self) -> impl Iterator<Item = &str>

Returns an iterator over the path components as string slices.

pub fn len(&self) -> usize

Returns the number of components in the path.

pub fn is_empty(&self) -> bool

Returns true if the path has no components.

pub fn file_name(&self) -> Option<&str>

Returns the last component of the path, or None if empty.

pub fn as_str(&self) -> &str

Returns the path as a string slice.

pub fn to_path_buf(&self) -> PathBuf

Converts this Path to an owned PathBuf.

Trait Implementations

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

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

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

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

impl AsRef<Path> for String

fn as_ref(&self) -> &Path

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

impl AsRef<Path> for str

fn as_ref(&self) -> &Path

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

impl AsRef<str> for Path

fn as_ref(&self) -> &str

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

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Debug for Path

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

Formats the value using the given formatter.

impl Display for Path

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

Formats the value using the given formatter.

impl Hash for Path

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

Feeds this value into the given Hasher.

impl PartialEq for Path

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

impl StructuralPartialEq for Path