Struct FsPath 

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

Forward-slash separated literal filesystem path.

Always uses / regardless of host OS. std::fs::* accepts /-paths on both Unix and Windows, so no boundary conversion is needed in the client layer.

Implementations

impl FsPath

pub fn new(s: impl Into<String>) -> Self

Builds a new path from s without validation.

pub fn as_str(&self) -> &str

Returns the path as a &str.

pub fn into_string(self) -> String

Returns the underlying String.

pub fn is_empty(&self) -> bool

Returns true when the path is empty.

pub fn join(&self, segment: &str) -> Self

Returns a new path with segment appended after a / separator.

If self is empty the result is segment alone (no leading /). Trailing / in self is normalized.

pub fn push(&mut self, segment: &str)

Appends segment to this path in place, inserting a / separator unless self is empty or already ends with one.

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

Returns the final path component, if any.

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

Returns the path without its final component, if any.

pub fn with_file_name(&self, name: &str) -> Self

Replaces the final component of this path with name.

If self has no parent, the result is name alone.

pub fn strip_prefix(&self, prefix: &Self) -> Option<&str>

If self is rooted at prefix, returns the relative remainder (without leading /).

pub fn starts_with(&self, prefix: &Self) -> bool

Returns true when this path begins with prefix.

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

Iterates over the non-empty components of this path.

Trait Implementations

impl AsRef<FsPath> for Maildir

fn as_ref(&self) -> &FsPath

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

impl AsRef<Path> for FsPath

Available on crate feature client only.

fn as_ref(&self) -> &Path

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

impl AsRef<str> for FsPath

fn as_ref(&self) -> &str

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

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 Default for FsPath

fn default() -> FsPath

Returns the “default value” for a type.

impl Display for FsPath

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

Formats the value using the given formatter.

impl Eq for FsPath

impl From<&FsPath> for MaildirFlags

fn from(path: &FsPath) -> Self

Converts to this type from the input type.

impl From<&Path> for FsPath

Available on crate feature client only.

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for FsPath

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<FsPath> for Maildir

fn from(root: FsPath) -> Self

Converts to this type from the input type.

impl From<FsPath> for MaildirEntry

fn from(path: FsPath) -> Self

Converts to this type from the input type.

impl From<FsPath> for PathBuf

Available on crate feature client only.

fn from(path: FsPath) -> Self

Converts to this type from the input type.

impl From<MaildirEntry> for FsPath

fn from(entry: MaildirEntry) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FsPath

Available on crate feature client only.

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for FsPath

fn from(s: String) -> Self

Converts to this type from the input type.

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 StructuralPartialEq for FsPath