Struct DirMetadata 

pub struct DirMetadata<'a> { /* private fields */ }

The Metadata of all directories and files in the current directory

Example

use dir_meta::DirMetadata;

// With feature `async` enabled using `cargo add dir-meta --features async`
#[cfg(feature = "async")]
{
    let dir = DirMetadata::new("/path/to/directory").async_dir_metadata();
}

// With feature `sync` enabled using `cargo add dir-meta --features sync`
#[cfg(feature = "sync")]
{
    let dir = DirMetadata::new("/path/to/directory").sync_dir_metadata();
}

Implementations

impl<'a> DirMetadata<'_>

pub fn new(path: &'a str) -> Self

Create a new instance of Self but with the path as a &str

pub fn new_path_buf(path: PathBuf) -> Self

Create a new instance of Self

pub fn get_file(&self, file_name: &'a str) -> Vec<&'a FileMetadata<'_>>

Multiple files can have the same name if they are in different dirs so using this method returns a vector of FileMetadata

pub fn get_file_by_path(&self, path: &'a str) -> Option<&'a FileMetadata<'_>>

Get a file by it’s absolute path (from root)

pub async fn async_dir_metadata(self) -> Result<Self, Error>

Returns an error if the directory cannot be accessed Read all the directories and files in the given path in async fashion

pub fn sync_dir_metadata(self) -> Result<Self, Error>

Returns an error if the directory cannot be accessed Read all the directories and files in the given path

pub fn async_iter_dir<'life0, 'async_recursion>( &'a mut self, prepared_dir: &'life0 mut ReadDir, ) -> Pin<Box<dyn Future<Output = &'a mut Self> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'a: 'async_recursion,

Recursively iterate over directories inside directories

pub fn sync_iter_dir(&mut self, prepared_dir: &mut ReadDir) -> &mut Self

Recursively iterate over directories inside directories

pub fn dir_name(&self) -> &str

Get the name of the current directory

pub fn dir_path(&self) -> &Path

Get the path of the current directory

pub fn directories(&self) -> &[PathBuf]

Get all the sub-directories of the current directory

pub fn files(&'a self) -> &'a [FileMetadata<'a>]

Get all the files in the current directory and all the files in it’s sub-directory

pub fn size(&self) -> usize

Get the size of the directory including the size of all files in the sub-directories

pub fn size_formatted(&self) -> String

Get the size of the directory including the size of all files in the sub-directories in human readable format

pub fn errors(&'a self) -> &'a [DirError<'a>]

Get all the errors encountered while opening the sub-directories and files

Trait Implementations

impl<'a> Clone for DirMetadata<'a>

fn clone(&self) -> DirMetadata<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DirMetadata<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DirMetadata<'a>

fn default() -> DirMetadata<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for DirMetadata<'a>

fn eq(&self, other: &DirMetadata<'a>) -> 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<'a> Eq for DirMetadata<'a>

impl<'a> StructuralPartialEq for DirMetadata<'a>