Struct SPath

pub struct SPath { /* private fields */ }

An SPath can be constructed from a Path, io::DirEntry, or walkdir::DirEntry and guarantees the following:

• The full path is UTF-8 valid.
• It does NOT have to have a file NAME (.e.g, ‘./’). If no file_name, .file_name() will return “”

Implementations

impl SPath

Constructors that guarantee the SPath contract described in the struct

pub fn new(path: impl Into<PathBuf>) -> Result<Self>

Constructor for SPath accepting anything that implements Into.

Note: This is quite ergonomic and allows for avoiding a PathBuf allocation if a PathBuf is provided.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Constructor from Path and all impl AsRef.

Returns Result

Note: Prefer the use of the SPath::try_from(…) or new when available as it might avoid a PathBuf allocation.

pub fn from_path_ok(path: impl AsRef<Path>) -> Option<Self>

Constructor for anything that implements AsRef.

Returns Option. Useful for filter_map.

Note: Favor using concrete type functions like SPath::from_path_buf_ok when available.

pub fn from_path_buf_ok(path_buf: PathBuf) -> Option<Self>

Constructed from PathBuf returns an Option, none if validation fails. Useful for filter_map.

pub fn from_fs_entry_ok(fs_entry: DirEntry) -> Option<Self>

Constructor from fs::DirEntry returning an Option, none if validation fails. Useful for filter_map.

pub fn from_walkdir_entry_ok(wd_entry: DirEntry) -> Option<Self>

Constructor from walkdir::DirEntry returning an Option, none if validation fails. Useful for filter_map.

impl SPath

Public into path

pub fn into_path_buf(self) -> PathBuf

Consumes the SPath and returns its PathBuf.

pub fn path(&self) -> &Path

Returns a reference to the internal Path.

impl SPath

Public getters

pub fn to_str(&self) -> &str

Returns the &str of the path.

NOTE: We know that this must be Some() since the SPath constructor guarantees that the path.to_str() is valid.

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

Returns the Option<&str> representation of the path.file_name()

Note: if the OsStr cannot be made into utf8 will be None

pub fn name(&self) -> &str

Returns the &str representation of the path.file_name()

Note: If no file name (e.g., ./) or OsStr no utf8, will be empty string

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

Returns the Option<&str> representation of the file_stem()

Note: if the OsStr cannot be made into utf8 will be None

pub fn stem(&self) -> &str

Returns the &str representation of the file_name()

Note: If no file name (e.g., ./) or OsStr no utf8, will be empty string

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

Returns the Option<&str> representation of the extension().

NOTE: This should never be a non-UTF-8 string as the path was validated during SPath construction.

pub fn ext(&self) -> &str

Returns the extension or “” if no extension

pub fn is_dir(&self) -> bool

Returns true if the path represents a directory.

pub fn is_file(&self) -> bool

Returns true if the path represents a file.

pub fn exists(&self) -> bool

Checks if the path exists.

pub fn modified(&self) -> Result<SystemTime>

Returns the path.metadata modified.

pub fn modified_us(&self) -> Result<i64>

Returns the epoch duration in microseconds. Note: The maximum UTC date would be approximately 292277-01-09 04:00:54 UTC. Thus, for all intents and purposes, it is far enough to not worry.

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

Returns the parent directory as an Option.

pub fn join(&self, leaf_path: impl AsRef<Path>) -> Result<SPath>

Joins the provided leaf_path with the current path and returns an SPath.

pub fn new_sibling(&self, leaf_path: impl AsRef<Path>) -> Result<SPath>

Creates a new sibling SPath with the given leaf_path.

Trait Implementations

impl AsRef<Path> for SPath

fn as_ref(&self) -> &Path

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

impl Clone for SPath

fn clone(&self) -> SPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SPath

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

Formats the value using the given formatter.

impl Display for SPath

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

Formats the value using the given formatter.

impl From<&SPath> for PathBuf

fn from(val: &SPath) -> Self

Converts to this type from the input type.

impl From<&SPath> for String

fn from(val: &SPath) -> Self

Converts to this type from the input type.

impl From<SFile> for SPath

fn from(sfile: SFile) -> Self

Converts to this type from the input type.

impl From<SPath> for PathBuf

fn from(val: SPath) -> Self

Converts to this type from the input type.

impl From<SPath> for String

fn from(val: SPath) -> Self

Converts to this type from the input type.

impl TryFrom<&String> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &String) -> Result<SPath>

Performs the conversion.

impl TryFrom<&str> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &str) -> Result<SPath>

Performs the conversion.

impl TryFrom<DirEntry> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(fs_entry: DirEntry) -> Result<SPath>

Performs the conversion.

impl TryFrom<DirEntry> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(wd_entry: DirEntry) -> Result<SPath>

Performs the conversion.

impl TryFrom<PathBuf> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path_buf: PathBuf) -> Result<SPath>

Performs the conversion.

impl TryFrom<SPath> for SFile

type Error = Error

The type returned in the event of a conversion error.

fn try_from(spath: SPath) -> Result<SFile>

Performs the conversion.

impl TryFrom<String> for SPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: String) -> Result<SPath>

Performs the conversion.