Struct DirEntry

pub struct DirEntry { /* private fields */ }

An entry returned by the ReadDir iterator.

A DirEntry represents an item within a directory on the Brain’s Micro SD card. The Brain provides very little metadata on files, so only the base std DirEntry methods are supported.

Implementations

impl DirEntry

pub fn path(&self) -> PathBuf

Returns the full path to the directory item.

This path is creeated by joining the path of the call to read_dir to the name of the file.

Examples

for entry in fs::read_dir(".").unwrap() {
   println!("{:?}", entry.path());
}

This example will lead to output like:

"somefile.txt"
"breakingbadseason1.mp4"
"badapple.mp3"

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

Returns the metadata for the full path to the item.

This is equivalent to calling metadata with the output from DirEntry::path.

Errors

This function will error if the path does not exist.

Examples

for entry in read_dir("somepath") {
    println!(
        "{:?} is a {}.",
        entry.path(),
        match entry.metadata().is_file() {
            true => "file",
            false => "folder"
        }
    );
}

pub fn file_type(&self) -> Result<FileType>

Returns the file type of the file that this DirEntry points to.

This function is equivalent to getting the FileType from the metadata returned by DirEntry::metadata.

Errors

This function will error if the path does not exist.

Examples

for entry in read_dir("somepath") {
    println!(
        "{:?} is a {}.",
        entry.path(),
        match entry.file_type().is_file() {
            true => "file",
            false => "folder"
        }
    );
}

pub fn file_name(&self) -> FsString

Returns the name of the file not including any leading components.

The following paths will all lead to a file name of foo:

• ./foo
• ../foo
• /some/global/foo

Trait Implementations

impl Clone for DirEntry

fn clone(&self) -> DirEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirEntry

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

Formats the value using the given formatter.

impl Hash for DirEntry

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 DirEntry

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

fn eq(&self, other: &DirEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 DirEntry

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

impl StructuralPartialEq for DirEntry