Struct FolderPath 

pub struct FolderPath { /* private fields */ }

A folder path.

Implementations

impl FolderPath

Delete Files

pub fn delete_files(&self) -> Result<(), Error>

Deletes the files in the folder.

impl FolderPath

List Files

pub fn list_files(&self) -> Result<ListFilesOp, Error>

Creates a list-files operation on the folder.

The files will be returned in lexicographical order.

pub fn list_files_unsorted(&self) -> Result<ListFilesOp, Error>

Creates a list-files operation on the folder where the files may be unsorted.

The files will be returned in lexicographical order.

impl FolderPath

List Files as Vec

pub fn list_files_as_vec(&self) -> Result<Vec<FilePath>, Error>

Lists the files in the folder as a Vec<FilePath> sorted in lexicographical order.

Returns Ok(sorted_files).

pub fn list_files_as_vec_unsorted(&self) -> Result<Vec<FilePath>, Error>

Lists the files as a Vec<FilePath>.

Returns Ok(files).

pub fn list_files_to_vec( &self, target: &mut Vec<FilePath>, ) -> Result<usize, Error>

Lists the files from the folder and appends them to the target Vec.

Returns Ok(file_count).

Note

Only the appended files will be sorted, not the entire target.

pub fn list_files_to_vec_unsorted( &self, target: &mut Vec<FilePath>, ) -> Result<usize, Error>

Lists the files to the target Vec.

Returns Ok(file_count).

impl FolderPath

Construction

pub unsafe fn new(path: StoragePath) -> Self

Creates a folder path from the path.

Safety

The path must be a valid folder path.

impl FolderPath

Storage Path

pub fn path(&self) -> &StoragePath

Gets the storage path.

pub fn to_path(self) -> StoragePath

Converts the folder path to a storage path.

impl FolderPath

Current Working Directory

pub fn current_working_directory() -> Result<Self, Error>

Gets the current working directory.

impl FolderPath

Roots

pub fn unix_root() -> Self

Creates the unix root folder.

impl FolderPath

AsRef

pub fn as_str(&self) -> &str

Gets the path as a string.

impl FolderPath

Clone

pub fn clone_with_extra_capacity(&self, extra_capacity: usize) -> Self

Clones the path with the extra capacity.

impl FolderPath

Append

pub fn with_appended<S>(self, string: S) -> StoragePath

where S: AsRef<str>,

Appends the string.

pub fn clone_append<S>(&self, string: S) -> StoragePath

where S: AsRef<str>,

Clones the path and appends the string.

The result is the same as path.clone().with_appended(s) but with a single allocation.

impl FolderPath

Append Char

pub fn with_appended_char(self, c: char) -> StoragePath

Appends the char.

impl FolderPath

Make File

pub fn make_file(self, file_name: &str) -> Result<FilePath, Error>

Makes the folder path a file path.

Returns None if the file_name is empty or ends with the file-separator.

impl FolderPath

Length

pub fn len(&self) -> usize

Gets the path length. (in bytes)

pub fn is_empty(&self) -> bool

Checks if the path is empty.

impl FolderPath

Is System

pub fn is_local_path(&self) -> bool

Checks if the path is a local path.

impl FolderPath

Is System

pub fn is_unix_path(&self) -> bool

Checks if the path is a Unix path.

impl FolderPath

Is System

pub fn is_windows_path(&self) -> bool

Checks if the path is a Windows path.

Trait Implementations

impl AsRef<FolderPath> for FolderPath

fn as_ref(&self) -> &FolderPath

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

impl AsRef<OsStr> for FolderPath

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for FolderPath

fn as_ref(&self) -> &Path

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

impl AsRef<str> for FolderPath

fn as_ref(&self) -> &str

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

impl Clone for FolderPath

fn clone(&self) -> FolderPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FolderPath

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

Formats the value using the given formatter.

impl Display for FolderPath

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

Formats the value using the given formatter.

impl From<FolderPath> for StoragePath

fn from(path: FolderPath) -> Self

Converts to this type from the input type.

impl Hash for FolderPath

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 FolderPath

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

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

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

impl StructuralPartialEq for FolderPath