Struct GenericDir 

pub struct GenericDir { /* private fields */ }

Generic directory type for type-erased directory operations.

This type can be used when you need to work with directories in a generic way, without knowing their specific type at compile time. It supports conversion to and from any typed directory struct.

Examples

use tree_type::{dir_type, GenericDir};

dir_type!(CacheDir);

let cache = CacheDir::new("/var/cache")?;
let generic: GenericDir = cache.into();
let cache_again = CacheDir::from_generic(generic);

Implementations

impl GenericDir

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

Create a new wrapper for a directory

Errors

If the directory is invalid. Invalid directory includes being empty.

pub fn as_path(&self) -> &Path

pub fn exists(&self) -> bool

pub fn as_generic(&self) -> GenericDir

Returns a clone of the GenericDir

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

Creates a new, empty directory at the provided path

Errors

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

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

Recursively create a directory and all of its parent components if they are missing.

Errors

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

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

Removes an empty directory.

Errors

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

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

Removes a directory at this path, after removing all its contents. Use carefully!

Errors

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

pub fn read_dir(&self) -> Result<impl Iterator<Item = Result<GenericPath>>>

Returns an iterator over the entries within a directory.

Errors

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

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. For root paths like “/”, returns an empty string. See std::path::Path::file_name for more details.

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

Renames this directory to a new name, replacing the original item if to already exists.

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::GenericDir;

let dir = GenericDir::new("old_dir")?;
match dir.rename("new_dir") {
    Ok(renamed_dir) => {
        // Use renamed_dir
    }
    Err((error, original_dir)) => {
        // Handle error, original_dir is still available
    }
}

Errors

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

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

Get the parent directory as GenericDir. Returns None for directories at the root level.

Trait Implementations

impl AsRef<Path> for GenericDir

fn as_ref(&self) -> &Path

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

impl Clone for GenericDir

fn clone(&self) -> GenericDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericDir

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

Formats the value using the given formatter.

impl Display for GenericDir

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

Formats the value using the given formatter.

impl Ord for GenericDir

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

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

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

impl StructuralPartialEq for GenericDir