Struct FileChange 

#[non_exhaustive]
pub struct FileChange {
    pub path: PathBuf,
    pub old_path: Option<PathBuf>,
    pub kind: ChangeKind,
}

One changed path in the working copy, unified across git status / jj diff --summary.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: PathBuf

The path (the new path for a rename).

A PathBuf (not a String) so a filename whose bytes are not valid UTF-8 — legal on Unix — is carried losslessly from status/diff and can be fed straight back into Repo::commit_paths / the backend add. A String filled via String::from_utf8_lossy would substitute U+FFFD and address a different file. See the crate’s serde-policy note for how a non-UTF-8 path is emitted as JSON.

old_path: Option<PathBuf>

The original path for a rename, populated by both backends (git’s R old -> new status; jj’s {old => new} diff-summary form); None for non-renames.

kind: ChangeKind

How the file changed.

Implementations

impl FileChange

pub fn new(path: impl Into<PathBuf>, kind: ChangeKind) -> Self

A change to path of the given kind, with no original path. Chain the old_path setter for a rename or copy. Lets an external VcsRepo impl or a test build one despite the #[non_exhaustive].

pub fn old_path(self, old: impl Into<PathBuf>) -> Self

Record the original path — a rename’s or copy’s source (sets the old_path field, which both a rename and a copy populate).

Trait Implementations

impl Clone for FileChange

fn clone(&self) -> FileChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileChange

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

Formats the value using the given formatter.

impl Eq for FileChange

impl PartialEq for FileChange

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileChange

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileChange