Struct ignore::DirEntry

source ·
pub struct DirEntry { /* private fields */ }
Expand description

A directory entry with a possible error attached.

The error typically refers to a problem parsing ignore files in a particular directory.

Implementations§

source§

impl DirEntry

source

pub fn path(&self) -> &Path

The full path that this entry represents.

source

pub fn into_path(self) -> PathBuf

The full path that this entry represents. Analogous to DirEntry::path, but moves ownership of the path.

Whether this entry corresponds to a symbolic link or not.

source

pub fn is_stdin(&self) -> bool

Returns true if and only if this entry corresponds to stdin.

i.e., The entry has depth 0 and its file name is -.

source

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

Return the metadata for the file that this entry points to.

source

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

Return the file type for the file that this entry points to.

This entry doesn’t have a file type if it corresponds to stdin.

source

pub fn file_name(&self) -> &OsStr

Return the file name of this entry.

If this entry has no file name (e.g., /), then the full path is returned.

source

pub fn depth(&self) -> usize

Returns the depth at which this entry was created relative to the root.

source

pub fn ino(&self) -> Option<u64>

Returns the underlying inode number if one exists.

If this entry doesn’t have an inode number, then None is returned.

source

pub fn error(&self) -> Option<&Error>

Returns an error, if one exists, associated with processing this entry.

An example of an error is one that occurred while parsing an ignore file. Errors related to traversing a directory tree itself are reported as part of yielding the directory entry, and not with this method.

Trait Implementations§

source§

impl Clone for DirEntry

source§

fn clone(&self) -> DirEntry

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DirEntry

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.