Struct EntryMode

pub struct EntryMode { /* private fields */ }

The mode of items storable in a tree, similar to the file mode on a unix file system.

Used in mutable::Entry and EntryRef.

Note that even though it can be created from any u16, it should be preferable to create it by converting EntryKind into EntryMode.

Implementations

impl EntryMode

pub const fn value(self) -> u16

Expose the value as u16 (lossy, unlike the internal representation that is hidden).

pub fn as_bytes<'a>(&self, backing: &'a mut [u8; 6]) -> &'a BStr

Return the representation as used in the git internal format, which is octal and written to the backing buffer. The respective sub-slice that was written to is returned.

pub fn from_bytes(i: &[u8]) -> Option<Self>

Construct an EntryMode from bytes represented as in the git internal format.

impl EntryMode

pub const fn kind(&self) -> EntryKind

Discretize the raw mode into an enum with well-known state while dropping unnecessary details.

pub const fn is_tree(&self) -> bool

Return true if this entry mode represents a Tree/directory

pub const fn is_commit(&self) -> bool

Return true if this entry mode represents the commit of a submodule.

pub const fn is_link(&self) -> bool

Return true if this entry mode represents a symbolic link

pub const fn is_no_tree(&self) -> bool

Return true if this entry mode represents anything BUT Tree/directory

pub const fn is_blob(&self) -> bool

Return true if the entry is any kind of blob.

pub const fn is_executable(&self) -> bool

Return true if the entry is an executable blob.

pub const fn is_blob_or_symlink(&self) -> bool

Return true if the entry is any kind of blob or symlink.

pub const fn as_str(&self) -> &'static str

Represent the mode as descriptive string.

Trait Implementations

impl Clone for EntryMode

fn clone(&self) -> EntryMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntryMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntryMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EntryKind> for EntryMode

fn from(value: EntryKind) -> Self

Converts to this type from the input type.

impl From<EntryMode> for EntryKind

fn from(value: EntryMode) -> Self

Converts to this type from the input type.

impl Hash for EntryMode

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 Octal for EntryMode

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

Formats the value using the given formatter.

impl Ord for EntryMode

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for EntryMode

type Error = &'a [u8]

The type returned in the event of a conversion error.

fn try_from(mode: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for EntryMode

type Error = u32

The type returned in the event of a conversion error.

fn try_from(mode: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for EntryMode

impl Eq for EntryMode

impl StructuralPartialEq for EntryMode