Struct simple_fs::SFile

pub struct SFile { /* private fields */ }

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

• The entry is a file (exists).
• It has a file name.
• The full path is UTF-8 valid.

Implementations

impl SFile

Constructors that guarantees the SFile contract describe in the struct

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

Constructor from Path.

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

Constructor from fs DirEntry.

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

Constructor from walkdir entry.

impl SFile

Public return Path constructs.

pub fn into_path_buf(self) -> PathBuf

pub fn path(&self) -> &Path

impl SFile

Public file components as str methods.

pub fn to_str(&self) -> &str

Returns the &str of the path.

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

pub fn file_name(&self) -> &str

Returns the &str representation of the file_name()

NOTE: According to the constructors’ contract, this method will never return “” as a file_name() is required for construction.

pub fn stem(&self) -> &str

Returns the &str representation of the file_name()

NOTE: According to the constructors’ contract, this method will never return “” as a file_name() is required for construction, and stem is always part of it.

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 SFile construction.

Trait Implementations

impl Debug for SFile

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

Formats the value using the given formatter.