Struct FsPath 

pub struct FsPath { /* private fields */ }

Provider-local filesystem path.

Implementations

impl FsPath

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

Parses and normalizes a filesystem path.

Parameters

• path: Raw path string.

Returns

Normalized provider-local path.

Errors

Returns FsError when the path is empty, contains a NUL byte, or tries to escape above its root with ...

pub fn root() -> Self

Creates the absolute root path.

Returns

Root filesystem path.

pub fn is_absolute(&self) -> bool

Tells whether this path is absolute.

Returns

true when the path starts at the provider root.

pub fn as_str(&self) -> &str

Gets the normalized path string.

Returns

Normalized path string using / separators.

pub fn join(&self, child: &str) -> FsResult<Self>

Joins a child path to this path.

Parameters

• child: Relative or absolute child path.

Returns

Joined path. Absolute child paths replace the base path.

Errors

Returns FsError when child is not a valid path.

pub fn parent(&self) -> Option<Self>

Gets this path’s parent.

Returns

Some parent path when the path has one, or None for root and parentless relative paths.

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

Gets the final path component.

Returns

Some file name when one exists, or None for root.

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

Gets the final path component extension.

Returns

Some extension without the dot when the final path component has a non-empty extension, or None for root, extensionless names, hidden names such as .profile, and names ending with a dot.

Trait Implementations

impl Clone for FsPath

fn clone(&self) -> FsPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsPath

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

Formats the value using the given formatter.

impl Display for FsPath

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

Formats the value using the given formatter.

impl Hash for FsPath

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 FsPath

fn cmp(&self, other: &FsPath) -> 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 PartialEq for FsPath

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

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

impl StructuralPartialEq for FsPath