Struct FilePath

pub struct FilePath { /* private fields */ }

A file path.

Implementations

impl FilePath

Construction

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

Creates a file path from the path.

Unsafe

The path must be a file path.

impl FilePath

Storage Path

pub fn path(&self) -> &StoragePath

Gets the storage path.

pub fn to_path(self) -> StoragePath

Converts the file path to a storage path.

impl FilePath

Is System

pub fn is_local_path(&self) -> bool

Checks if the path is a local path.

pub fn is_unix_path(&self) -> bool

Checks if the path is a Unix path.

pub fn is_windows_path(&self) -> bool

Checks if the path is a Windows path.

impl FilePath

AsRef

pub fn as_str(&self) -> &str

Gets the path as a string.

impl FilePath

Clone

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

Clones the path with the extra capacity.

impl FilePath

Append

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

where S: AsRef<str>,

Appends the string.

pub fn clone_append<S>(&self, s: 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 minimizes allocation.

impl FilePath

Append Char

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

Appends the char.

impl FilePath

Make Folder

pub fn make_folder(self) -> FolderPath

Makes the file a folder by appending a file separator.

impl FilePath

Length

pub fn len(&self) -> usize

Gets the path length. (in bytes)

impl FilePath

Delete

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

Deletes the file.

Returns Ok(()) if the file was deleted or if the file did not exist.

impl FilePath

Delete If Exists

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

Deletes the file if it exists.

Returns Ok(true) if the file existed and was deleted. Returns Ok(false) if the file did not exist.

impl FilePath

Exists

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

Checks if the file exists.

impl FilePath

Read as String

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

Reads the file as a String.

Returns Ok(file_content). Returns Err(FileNotFound) if the file did not exist.

impl FilePath

Read as String If Exists

pub fn read_as_string_if_exists(&self) -> Result<Option<String>, Error>

Reads the file as a String if it exists.

Returns Ok(Some(file_content)). Returns Ok(None) if the file did not exist.

impl FilePath

Read as Vec

pub fn read_as_vec(&self) -> Result<Vec<u8>, Error>

Reads the file as a Vec.

Returns Ok(file_content). Returns Err(FileNotFound) if the file did not exist.

impl FilePath

Read as Vec If Exists

pub fn read_as_vec_if_exists(&self) -> Result<Option<Vec<u8>>, Error>

Reads the file as a Vec<u8> if it exists.

Returns Ok(Some(file_content)). Returns Ok(None) if the file did not exist.

impl FilePath

Read to String

pub fn read_to_string(&self, target: &mut String) -> Result<usize, Error>

Reads the file to the target String.

Returns Ok(file_content_len). Returns Err(FileNotFound) if the file did not exist.

impl FilePath

Read to String If Exists

pub fn read_to_string_if_exists( &self, target: &mut String, ) -> Result<Option<usize>, Error>

Reads the file to the target String if it exists.

Returns Ok(Some(file_content_len)). Returns Ok(None) if the file did not exist.

impl FilePath

Read to Vec

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

Reads the file to the target Vec.

Returns Ok(file_content_len). Returns Err(FileNotFound) if the file did not exist.

impl FilePath

Read to Vec If Exists

pub fn read_to_vec_if_exists( &self, target: &mut Vec<u8>, ) -> Result<Option<usize>, Error>

Reads the file to the target Vec if it exists.

Returns Ok(Some(file_content_len)). Returns Ok(None) if the file did not exist.

impl FilePath

Write Data

pub fn write_data<D>(&self, data: D) -> Result<(), Error>

where D: AsRef<[u8]>,

Writes the data to the file.

Returns Ok(()). Returns Err(FileAlreadyExists) if the file already exists.

impl FilePath

Write Data If-Not-Exists

pub fn write_data_if_not_exists<D>(&self, data: D) -> Result<bool, Error>

where D: AsRef<[u8]>,

Writes the data to the file if the file does not already exist.

Returns Ok(true) if the file was written. Returns Ok(false) if the file already existed.

impl FilePath

Write Empty

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

Writes an empty file.

Returns Ok(()). Returns Err(FileAlreadyExists) if the file already exists.

impl FilePath

Write Empty If-Not-Exists

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

Writes an empty file if the file does not exist.

Returns Ok(true) if the file was written. Returns Ok(false) if the file already existed.

impl FilePath

Write String

pub fn write_str<S>(&self, string: S) -> Result<(), Error>

where S: AsRef<str>,

Writes the string to the file.

Returns Ok(()). Returns Err(FileAlreadyExists) if the file already exists.

impl FilePath

Write Data If-Not-Exists

pub fn write_str_if_not_exists<S>(&self, string: S) -> Result<bool, Error>

where S: AsRef<str>,

Writes the string to the file if the file does not exist.

Returns Ok(true) if the file was written. Returns Ok(false) if the file already existed.

Trait Implementations

impl AsRef<FilePath> for FilePath

fn as_ref(&self) -> &FilePath

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

impl AsRef<OsStr> for FilePath

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for FilePath

fn as_ref(&self) -> &Path

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

impl AsRef<str> for FilePath

fn as_ref(&self) -> &str

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

impl Clone for FilePath

fn clone(&self) -> FilePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilePath

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

Formats the value using the given formatter.

impl Display for FilePath

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 Hash for FilePath

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 FilePath

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

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

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

impl StructuralPartialEq for FilePath