Struct FileMode 

pub struct FileMode(/* private fields */);

A Git file mode (100644, 100755, 120000, 160000, 040000), or FileMode::ABSENT for the missing side of an add or delete.

Displays and serializes as the six-digit octal text Git prints in raw diff output, so the zero mode reads 000000.

Examples

use grit_lib::objects::FileMode;

assert_eq!(FileMode::EXECUTABLE.to_string(), "100755");
assert_eq!(FileMode::ABSENT.to_string(), "000000");
assert_eq!(FileMode::new(0o120000), FileMode::SYMLINK);
assert!(FileMode::SYMLINK.is_symlink());

Implementations

impl FileMode

pub const ABSENT: Self

No entry on this side (an add’s old side, a delete’s new side).

pub const REGULAR: Self

Regular, non-executable file.

pub const EXECUTABLE: Self

Executable file.

pub const SYMLINK: Self

Symbolic link.

pub const GITLINK: Self

Submodule commit (gitlink).

pub const TREE: Self

Tree (directory).

pub const fn new(bits: u32) -> Self

Wrap raw mode bits as stored in a tree entry or the index.

pub const fn bits(self) -> u32

The raw mode bits.

pub const fn is_absent(self) -> bool

Whether this is Self::ABSENT.

pub fn octal_if_present(self) -> Option<String>

The octal text, or None for Self::ABSENT (the missing side of an add or delete).

pub const fn is_symlink(self) -> bool

Whether the object-type bits name a symbolic link.

pub const fn is_gitlink(self) -> bool

Whether the object-type bits name a gitlink (submodule commit).

Trait Implementations

impl Clone for FileMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileMode

impl Debug for FileMode

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

Formats the value using the given formatter.

impl Default for FileMode

fn default() -> Self

Returns the “default value” for a type.

impl Display for FileMode

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

Formats the value using the given formatter.

impl Eq for FileMode

impl From<FileMode> for u32

fn from(mode: FileMode) -> Self

Converts to this type from the input type.

impl From<u32> for FileMode

fn from(bits: u32) -> Self

Converts to this type from the input type.

impl Hash for FileMode

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 FileMode

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FileMode

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for FileMode

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for FileMode