Struct FsPath

pub struct FsPath {
    pub path: PathBuf,
}

Available on crate feature std only.

🌐 A more featureful wrapper over PathBuf.

Table of contents

• General methods
• Methods that traverse symbolic links
• Methods that optionally traverse symbolic links
• unix methods that traverse symbolic links
• unix methods that optionally traverse symbolic links
• windows methods

Symlink traversal

Most methods traverse symbolic links along the path, while the _ts suffixed variants can do so, optionally.

assert_eq![some_path.exists(), some_path.exists_ts(true)];

Fields

path: PathBuf

The inner PathBuf.

Implementations

impl FsPath

General methods.

pub fn new<P: AsRef<Path>>(path: P) -> Self

Returns a FsPath from what could’ve been a Path.

pub fn from_current_dir() -> IoResult<Self>

Returns the current working directory.

Calls std::env::current_dir under the hood.

pub fn from_manifest_dir() -> Self

Retuns the path of CARGO_MANIFEST_DIR.

pub fn from_manifest_path() -> Self

Retuns the path of CARGO_MANIFEST_PATH.

pub fn from_temp_dir() -> Self

Returns a temporary directory.

Calls std::env::temp_dir under the hood.

pub fn from_crate_root<P: AsRef<Path>>(path: P) -> IoResult<Self>

Resolves a given path relative to the nearest Cargo.toml directory.

This function searches for the nearest Cargo.toml file starting from the current working directory and traversing upwards through its ancestors. Once the Cargo.toml is found, the provided path is appended to its directory.

Errors

Returns an error if it can’t find any Cargo.toml file, or if it encounters an invalid path during the search process.

Examples

use devela::FsPath;
match FsPath::from_crate_root("") {
    Ok(p) => println!("Current crate root is {:?}", p),
    Err(e) => println!("Error obtaining crate root {:?}", e)
};

pub fn canonicalize(&self) -> IoResult<FsPath>

Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.

Calls std::fs::canonicalize under the hood.

pub fn read_link(&self) -> IoResult<FsPath>

Reads a symbolic link, returning the file that the link points to.

This function will return an error in the following situations, but is not limited to just these cases:

• path is not a symbolic link.
• path does not exist.

Calls std::fs::read_link under the hood.

pub fn is_absolute(&self) -> bool

Is this path absolute?

pub fn is_relative(&self) -> bool

Is this path relative?

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

Returns the path without its final component, if there is one.

Returns None if the path terminates in a root or prefix.

pub fn pop(&mut self) -> bool

Truncates self to self.parent.

Returns false and does nothing if self.parent is None. Otherwise, returns true.

pub fn push<P: AsRef<Path>>(&mut self, path: P)

Extends self with path.

If path is absolute, it replaces the current path.

Calls std::path::PathBuf::push under the hood.

pub fn display(&self) -> PathDisplay<'_>

Returns an object that implements Display.

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

Yields a &str slice if the FsPath is valid unicode.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts a FsPath to a Cow<str>.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

pub fn into_inner(self) -> PathBuf

Returns the inner PathBuf.

pub fn into_ref_mut(&mut self) -> &mut PathBuf

Returns an exclusive reference to the inner PathBuf.

pub fn as_path(&self) -> &Path

Coerces the inner PathBuf to a Path slice.

impl FsPath

Methods that traverse symbolic links

pub fn exists(&self) -> bool

Does this path exist?

pub fn is_file(&self) -> bool

Is this a file?

pub fn is_dir(&self) -> bool

Is this a directory?

pub fn is_symlink(&self) -> bool

Is this a symbolic link?

pub fn metadata(&self) -> IoResult<FileMetadata>

Returns the metadata.

pub fn file_type(&self) -> IoResult<FileType>

Returns the FileType.

pub fn len(&self) -> IoResult<u64>

Returns the size of the file, in bytes.

pub fn is_empty(&self) -> IoResult<bool>

Returns true if the file size equals zero.

pub fn created(&self) -> IoResult<SystemTime>

Returns the time of creation.

pub fn accessed(&self) -> IoResult<SystemTime>

Returns the time of access.

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

Returns the time of modification.

pub fn permissions(&self) -> IoResult<FilePermissions>

Returns the permissions of the file.

pub fn is_readonly(&self) -> IoResult<bool>

Is this a read-only file?

pub fn set_readonly(&mut self, readonly: bool) -> IoResult<bool>

Sets the read-only flag, returning the previous read-only state.

impl FsPath

Methods that optionally

traverse symbolic links

pub fn exists_ts(&self, traverse: bool) -> bool

Does this path exist?

pub fn is_file_ts(&self, traverse: bool) -> bool

Is this a file?

pub fn is_dir_ts(&self, traverse: bool) -> bool

Is this a directory?

pub fn is_symlink_ts(&self, traverse: bool) -> bool

Is this a symbolic link?

pub fn metadata_ts(&self, traverse: bool) -> IoResult<FileMetadata>

Returns the metadata that optionally traverses symbolic links.

pub fn file_type_ts(&self, traverse: bool) -> IoResult<FileType>

Returns the FileType.

pub fn len_ts(&self, traverse: bool) -> IoResult<u64>

Returns the size of the file, in bytes.

pub fn is_empty_ts(&self, traverse: bool) -> IoResult<bool>

Returns true if the file size equals zero.

pub fn created_ts(&self, traverse: bool) -> IoResult<SystemTime>

Returns the time of creation.

pub fn accessed_ts(&self, traverse: bool) -> IoResult<SystemTime>

Returns the time of access.

pub fn modified_ts(&self, traverse: bool) -> IoResult<SystemTime>

Returns the time of modification.

pub fn permissions_ts(&self, traverse: bool) -> IoResult<FilePermissions>

Returns the permissions of the file.

pub fn is_readonly_ts(&self, traverse: bool) -> IoResult<bool>

Is this a read-only file?

pub fn set_readonly_ts( &mut self, readonly: bool, traverse: bool, ) -> IoResult<bool>

Sets the read-only flag, returning the previous read-only state.

impl FsPath

unix methods that traverse symbolic links

pub fn dev(&self) -> IoResult<u64>

Returns the ID of the device containing the file.

pub fn ino(&self) -> IoResult<u64>

Returns the inode number.

pub fn mode(&self) -> IoResult<u32>

Returns the rights applied to this file.

pub fn nlink(&self) -> IoResult<u64>

Returns the number of hard links pointing to this file.

pub fn uid(&self) -> IoResult<u32>

Returns the user ID of the owner of this file.

pub fn gid(&self) -> IoResult<u32>

Returns the group ID of the owner of this file.

pub fn rdev(&self) -> IoResult<u64>

Returns the device ID of this file (if it is a special one).

pub fn size(&self) -> IoResult<u64>

Returns the total size of this file in bytes.

pub fn atime(&self) -> IoResult<i64>

Returns the last access time of the file, in seconds since Unix Epoch.

pub fn atime_nsec(&self) -> IoResult<i64>

Returns the last access time of the file, in nanoseconds since atime.

pub fn mtime(&self) -> IoResult<i64>

Returns the last modification time of the file, in seconds since Unix Epoch.

pub fn mtime_nsec(&self) -> IoResult<i64>

Returns the last modification time of the file, in nanoseconds since mtime.

pub fn ctime(&self) -> IoResult<i64>

Returns the last status change time of the file, in seconds since Unix Epoch.

pub fn ctime_nsec(&self) -> IoResult<i64>

Returns the last status change time of the file, in nanoseconds since ctime.

pub fn blksize(&self) -> IoResult<u64>

Returns the block size for filesystem I/O.

pub fn blocks(&self) -> IoResult<u64>

Returns the number of blocks allocated to the file, in 512-byte units.

impl FsPath

unix methods that optionally

traverse symbolic links

pub fn dev_ts(&self, traverse: bool) -> IoResult<u64>

Returns the ID of the device containing the file.

pub fn ino_ts(&self, traverse: bool) -> IoResult<u64>

Returns the inode number.

pub fn mode_ts(&self, traverse: bool) -> IoResult<u32>

Returns the rights applied to this file.

pub fn nlink_ts(&self, traverse: bool) -> IoResult<u64>

Returns the number of hard links pointing to this file.

pub fn uid_ts(&self, traverse: bool) -> IoResult<u32>

Returns the user ID of the owner of this file.

pub fn gid_ts(&self, traverse: bool) -> IoResult<u32>

Returns the group ID of the owner of this file.

pub fn rdev_ts(&self, traverse: bool) -> IoResult<u64>

Returns the device ID of this file (if it is a special one).

pub fn size_ts(&self, traverse: bool) -> IoResult<u64>

Returns the total size of this file in bytes.

pub fn atime_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last access time of the file, in seconds since Unix Epoch.

pub fn atime_nsec_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last access time of the file, in nanoseconds since atime.

pub fn mtime_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last modification time of the file, in seconds since Unix Epoch.

pub fn mtime_nsec_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last modification time of the file, in nanoseconds since mtime.

pub fn ctime_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last status change time of the file, in seconds since Unix Epoch.

pub fn ctime_nsec_ts(&self, traverse: bool) -> IoResult<i64>

Returns the last status change time of the file, in nanoseconds since ctime.

pub fn blksize_ts(&self, traverse: bool) -> IoResult<u64>

Returns the block size for filesystem I/O.

pub fn blocks_ts(&self, traverse: bool) -> IoResult<u64>

Returns the number of blocks allocated to the file, in 512-byte units.

impl FsPath

windows methods

pub fn file_attributes(&self) -> IoResult<u32>

Returns the value of the dwFileAttributes field of this metadata.

pub fn creation_time(&self) -> IoResult<u64>

Returns the value of the ftCreationTime field of this metadata.

pub fn last_access_time(&self) -> IoResult<u64>

Returns the value of the ftLastAccessTime field of this metadata.

pub fn last_write_time(&self) -> IoResult<u64>

Returns the value of the ftLastWriteTime field of this metadata.

pub fn file_size(&self) -> IoResult<u64>

Returns the value of the nFileSize{High,Low} fields of this metadata.

Trait Implementations

impl Clone for FsPath

fn clone(&self) -> FsPath

Returns a copy 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<'a> From<&'a FsPath> for &'a Path

fn from(fspath: &'a FsPath) -> Self

Converts to this type from the input type.

impl<'a> From<&'a FsPath> for &'a PathBuf

fn from(fspath: &'a FsPath) -> Self

Converts to this type from the input type.

impl From<&FsPath> for PathBuf

fn from(fspath: &FsPath) -> Self

Converts to this type from the input type.

impl From<&Path> for FsPath

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for FsPath

fn from(path: &PathBuf) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut FsPath> for &'a Path

fn from(fspath: &'a mut FsPath) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut FsPath> for &'a mut PathBuf

fn from(fspath: &'a mut FsPath) -> Self

Converts to this type from the input type.

impl From<&mut FsPath> for PathBuf

fn from(fspath: &mut FsPath) -> Self

Converts to this type from the input type.

impl From<&mut Path> for FsPath

fn from(path: &mut Path) -> Self

Converts to this type from the input type.

impl From<&mut PathBuf> for FsPath

fn from(path: &mut PathBuf) -> Self

Converts to this type from the input type.

impl From<FsPath> for PathBuf

fn from(fspath: FsPath) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FsPath

fn from(path: PathBuf) -> Self

Converts to this type from the input type.