Struct GenericFile 

pub struct GenericFile { /* private fields */ }

Implementations

impl GenericFile

pub fn new(path: impl Into<PathBuf>) -> Result<Self>

Create a new wrapper for a file

Errors

If the file name is invalid. Invalid file name inclued empty file name.

pub fn as_path(&self) -> &Path

pub fn exists(&self) -> bool

pub fn as_generic(&self) -> GenericFile

pub fn read(&self) -> Result<Vec<u8>>

Reads the entire contents of a file into a bytes vector.

Errors

May return any of the same errors as std::fs::read

pub fn read_to_string(&self) -> Result<String>

Reads the entire contents of a file into a string.

Errors

May return any of the same errors as std::fs::read_to_string

pub fn write<C: AsRef<[u8]>>(&self, contents: C) -> Result<()>

Writes a slice as the entire contents of a file.

Errors

May return any of the same errors as std::fs::write

pub fn create(&self) -> Result<()>

Create an empty file if it doesn’t already exist

Errors

May return any of the same errors as std::fs::open

pub fn remove(&self) -> Result<()>

Removes a file from the filesystem.

Errors

May return any of the same errors as std::fs::remove_file

pub fn fs_metadata(&self) -> Result<Metadata>

Given a path, queries the file system to get information about a file, directory, etc.

Errors

May return any of the same errors as std::fs::metadata

pub fn file_name(&self) -> String

Returns the final component of the path as a String. See std::path::Path::file_name for more details.

pub fn rename(self, new_path: impl AsRef<Path>) -> Result<Self, (Error, Self)>

Rename/move this file to a new path.

Consumes the original instance and returns a new instance with the updated path on success. On failure, returns both the error and the original instance for recovery. Parent directories are created automatically if they don’t exist.

Examples

use tree_type::GenericFile;

let file = GenericFile::new("old.txt")?;
match file.rename("new.txt") {
    Ok(renamed_file) => {
        // Use renamed_file
    }
    Err((error, original_file)) => {
        // Handle error, original_file is still available
    }
}

Errors

May return any of the same errors as std::fs::rename

pub fn parent(&self) -> GenericDir

Get the parent directory as GenericDir. Files always have a parent directory.

Trait Implementations

impl AsRef<Path> for GenericFile

fn as_ref(&self) -> &Path

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

impl Clone for GenericFile

fn clone(&self) -> GenericFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericFile

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

Formats the value using the given formatter.

impl Display for GenericFile

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

Formats the value using the given formatter.

impl Ord for GenericFile

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

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

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

impl StructuralPartialEq for GenericFile