Enum Kind

pub enum Kind {
    Untrackable,
    File,
    Symlink,
    Directory,
    Repository,
}

The kind of the entry, seated in their kinds available on disk.

Variants

Untrackable

Something that is not a regular file, directory, or symbolic link.

These can only exist in the filesystem, because Git repositories do not support them, thus they cannot be tracked. Hence, they do not appear as blobs in a repository, and their type is not specifiable in a tree object. Examples include named pipes (FIFOs), character devices, block devices, and sockets.

File

The entry is a blob, representing a regular file, executable or not.

Symlink

The entry is a symlink.

Directory

The entry is an ordinary directory.

Note that since we don’t check for bare repositories, this could in fact be a collapsed bare repository. To be sure, check it again with gix_discover::is_git() and act accordingly.

Repository

The entry is a directory which contains a .git folder, or a submodule entry in the index.

Implementations

impl Kind

pub fn is_dir(&self) -> bool

Return true if this is a directory on disk. Note that this is true for repositories as well.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl From<FileType> for Kind

fn from(value: FileType) -> Self

Converts to this type from the input type.

impl Hash for Kind

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 Kind

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

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

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

impl Eq for Kind

impl StructuralPartialEq for Kind