Struct StoragePath

pub struct StoragePath { /* private fields */ }

A file or folder path.

Base & Extension

Storage paths are divided into a base and an extension. The base is effectively immutable and the extension is a sequence of segments divided by file-separators.

Unix Example: Path: /the/path Base: / Extension: the/path

Windows Example: Path: C:\The\Path Base: C:
Extension: The\Path

URL Example: Path: https://example.com/the/path Base: https://example.com/ Extension: the/path

Files & Folders

A storage path can be a file path or a folder path. These are mutually exclusive and exhaustive. A storage path is a folder path if it is equal to its base or ends with a file-separator, otherwise it is a file path.

Implementations

impl StoragePath

Construction

pub unsafe fn new<S>(path: S, base_len: usize, file_separator: char) -> Self

where S: Into<String>,

Creates a new storage path.

Safety

The base_len must be a valid char boundary in the path.

impl StoragePath

Properties

pub fn path(&self) -> &str

Gets the path string.

pub unsafe fn path_mut(&mut self) -> &mut String

Gets the mutable path string.

Safety

The path string must remain valid for the path.

pub fn base_len(&self) -> usize

Gets the base length. (in bytes)

pub fn file_separator(&self) -> char

Gets the file separator.

impl StoragePath

Parse

pub fn parse<S>(path: S) -> Result<Self, Error>

where S: AsRef<str> + Into<String>,

Parses the path.

impl StoragePath

Roots

pub fn unix_root() -> Self

Creates the unix root path.

impl StoragePath

AsRef

pub fn as_str(&self) -> &str

Gets the path as a string.

impl StoragePath

To File or Folder

pub fn to_file(self) -> Result<FilePath, Error>

Converts the path to a file path.

Returns Err(self) if the path is not a file path.

pub fn to_folder(self) -> Result<FolderPath, Error>

Converts the path to a folder path.

Returns Err(self) if the path is not a folder path.

impl StoragePath

Clone

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

Clones the path with the extra capacity.

impl StoragePath

Append

pub fn append<S>(&mut self, string: S)

where S: AsRef<str>,

Appends the string.

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

where S: AsRef<str>,

Appends the string.

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

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 StoragePath

Append Char

pub fn append_char(&mut self, c: char)

Appends the char.

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

Appends the char.

impl StoragePath

Make File

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

Makes the path a file path.

If the path is a file the file will be returned.

If the path is a folder the file_name will be appended then: 1. If the path is a file the file will be returned. 2. If the file_name is empty or ends with the file-separator it will be None.

impl StoragePath

Make Folder

pub fn clone_make_folder(&self) -> FolderPath

Clones the path and makes the path a folder.

Returns the path as is if it is already a folder, otherwise appends a file-separator.

pub fn make_folder(self) -> FolderPath

Makes the storage path a folder.

Returns the path as is if it is already a folder, otherwise appends a file-separator.

impl StoragePath

Truncate

pub unsafe fn truncate(&mut self, new_len: usize)

Truncates the path to the new_len.

Safety

The new_len must be >= to the base_len and must be a valid char boundary.

pub unsafe fn truncated(self, new_len: usize) -> Self

Truncates the path to the new_len.

Safety

The new_len must be >= to the base_len and must be a valid char boundary.

impl StoragePath

Base & Extension

pub fn base(&self) -> &str

Gets the path base.

pub fn extension(&self) -> &str

Gets the path extension.

impl StoragePath

File or Folder

pub fn is_file(&self) -> bool

Checks if the path is a file. (if not, the path is a folder)

pub fn is_folder(&self) -> bool

Checks if the path is a folder. (if not, the path is a file)

impl StoragePath

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 StoragePath

Is System

pub fn is_local_path(&self) -> bool

Checks if the path is a local path.

pub fn is_local_path_str<S>(path: S) -> bool

where S: AsRef<str>,

Checks if the path is a local path.

impl StoragePath

Is System

pub fn is_unix_path(&self) -> bool

Checks if the path is a unix path.

pub fn is_unix_path_str<S>(path: S) -> bool

where S: AsRef<str>,

Checks if the path is a unix path.

impl StoragePath

Is System

pub fn is_windows_path(&self) -> bool

Checks if the path is a windows path.

pub fn is_windows_path_str<S>(path: S) -> bool

where S: AsRef<str>,

Checks if the path is a windows path.

Trait Implementations

impl AsRef<OsStr> for StoragePath

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for StoragePath

fn as_ref(&self) -> &Path

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

impl AsRef<StoragePath> for StoragePath

fn as_ref(&self) -> &StoragePath

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

impl AsRef<str> for StoragePath

fn as_ref(&self) -> &str

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

impl Clone for StoragePath

fn clone(&self) -> StoragePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoragePath

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

Formats the value using the given formatter.

impl Display for StoragePath

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

Formats the value using the given formatter.

impl From<FilePath> for StoragePath

fn from(path: FilePath) -> Self

Converts to this type from the input type.

impl From<FolderPath> for StoragePath

fn from(path: FolderPath) -> Self

Converts to this type from the input type.

impl Hash for StoragePath

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 StoragePath

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

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

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