Struct RelativePath 

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

A non-empty normalized relative path that cannot escape its base.

Examples

use qubit_fs::path::RelativePath;

let relative = RelativePath::parse("reports/2026")?;
assert_eq!("reports/2026", relative.as_str());

Implementations

impl RelativePath

pub fn parse(text: &str) -> FsResult<Self>

Parses a normalized relative path.

Returns an invalid-path error for empty or absolute input, NUL, or a traversal sequence that escapes above the relative root.

Parameters

• text: Relative path text to normalize and validate.

Errors

Returns an invalid-path error when text is empty, absolute, contains NUL, or escapes above the relative root.

pub fn as_str(&self) -> &str

Returns the normalized logical path text.

Trait Implementations

impl Clone for RelativePath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelativePath

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

Formats the value using the given formatter.

impl Display for RelativePath

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the normalized relative path.

impl Eq for RelativePath

impl Hash for RelativePath

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 PartialEq for RelativePath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RelativePath