Skip to main content

PathChange

Struct PathChange 

Source
pub struct PathChange {
    pub staged: Option<PathStatus>,
    pub unstaged: Option<PathStatus>,
    pub original_path: Option<PathBuf>,
}
Expand description

A path’s porcelain XY status, kept as the TWO independent axes git reports rather than collapsed into one value.

X is the index vs HEAD (“what a commit would record”) and Y is the working tree vs the index (“what staging would add”). They vary independently: MM means a file has staged changes and further unstaged ones, and it belongs in both of magit’s sections with “modified” on each row.

Collapsing them into a single PathStatus is what produced the reported bug — a staged modification (M ) had to be reported as Added to make it land in the staged section, so it rendered as “new file”, and MM had to be reported as Conflicted (which means a merge conflict) purely to make it appear in both. One value cannot answer both “which section” and “what label” without lying about one of them.

Fields§

§staged: Option<PathStatus>

Index vs HEAD. None when nothing is staged for this path.

§unstaged: Option<PathStatus>

Working tree vs index. None when the worktree matches the index. Also carries PathStatus::Untracked / Ignored / Unmerged, which are whole-path states rather than one axis.

§original_path: Option<PathBuf>

Where a PathStatus::Renamed / PathStatus::Copied path came from. None for every other status.

Implementations§

Source§

impl PathChange

Source

pub const CLEAN: Self

Nothing staged, nothing modified.

Source

pub fn is_clean(&self) -> bool

true when git reports no change on either axis.

Trait Implementations§

Source§

impl Clone for PathChange

Source§

fn clone(&self) -> PathChange

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PathChange

Source§

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

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

impl Eq for PathChange

Source§

impl PartialEq for PathChange

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PathChange

Auto Trait Implementations§

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, dest: *mut u8)

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

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

§

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

Compare self to key and return true if they are equal.
§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
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.