gix_status::index_as_worktree

Enum Change

Source
pub enum Change<T = (), U = ()> {
    Removed,
    Type,
    Modification {
        executable_bit_changed: bool,
        content_change: Option<T>,
        set_entry_stat_size_zero: bool,
    },
    SubmoduleModification(U),
}
Expand description

How an index entry needs to be changed to obtain the destination worktree state, i.e. entry.apply(this_change) == worktree-entry.

Variants§

§

Removed

This corresponding file does not exist in the worktree anymore.

§

Type

The type of file changed compared to the worktree, i.e. a symlink s now a file.

§

Modification

This worktree file was modified in some form, like a permission change or content change or both, as compared to this entry.

Fields

§executable_bit_changed: bool

Indicates that one of the stat changes was an executable bit change which is a significant change itself.

§content_change: Option<T>

The output of the CompareBlobs run on this entry. If there is no content change and only the executable bit changed then this is None.

§set_entry_stat_size_zero: bool

If true, the caller is expected to set entry.stat.size = 0 to assure this otherwise racily clean entry can still be detected as dirty next time this is called, but this time without reading it from disk to hash it. It’s a performance optimization and not doing so won’t change the correctness of the operation.

§

SubmoduleModification(U)

A submodule is initialized and checked out, and there was modification to either:

  • the HEAD as compared to the superproject’s desired commit for HEAD
  • the worktree has at least one modified file
  • there is at least one untracked file

The exact nature of the modification is handled by the caller which may retain information per submodule or re-compute details as needed when seeing this variant.

Trait Implementations§

Source§

impl<T: Clone, U: Clone> Clone for Change<T, U>

Source§

fn clone(&self) -> Change<T, U>

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<T: Debug, U: Debug> Debug for Change<T, U>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, U> From<Change<T, U>> for EntryStatus<T, U>

Source§

fn from(value: Change<T, U>) -> Self

Converts to this type from the input type.
Source§

impl<T: Ord, U: Ord> Ord for Change<T, U>

Source§

fn cmp(&self, other: &Change<T, U>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq, U: PartialEq> PartialEq for Change<T, U>

Source§

fn eq(&self, other: &Change<T, U>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd, U: PartialOrd> PartialOrd for Change<T, U>

Source§

fn partial_cmp(&self, other: &Change<T, U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Eq, U: Eq> Eq for Change<T, U>

Source§

impl<T, U> StructuralPartialEq for Change<T, U>

Auto Trait Implementations§

§

impl<T, U> Freeze for Change<T, U>
where U: Freeze, T: Freeze,

§

impl<T, U> RefUnwindSafe for Change<T, U>

§

impl<T, U> Send for Change<T, U>
where U: Send, T: Send,

§

impl<T, U> Sync for Change<T, U>
where U: Sync, T: Sync,

§

impl<T, U> Unpin for Change<T, U>
where U: Unpin, T: Unpin,

§

impl<T, U> UnwindSafe for Change<T, U>
where U: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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 T
where 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> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.