Struct FileDiff 

pub struct FileDiff {
    pub old_path: Option<String>,
    pub new_path: Option<String>,
    pub status: FileStatus,
    pub binary: bool,
    pub similarity: Option<u8>,
    pub old_mode: Option<String>,
    pub new_mode: Option<String>,
    pub hunks: Vec<Hunk>,
    pub header: Vec<String>,
    pub coarse: bool,
    /* private fields */
}

The changes to one file.

Fields

old_path: Option<String>

Path before the change (None for an added file); a/ and b/ prefixes are stripped.

new_path: Option<String>

Path after the change (None for a deleted file).

status: FileStatus

binary: bool

A binary file: no hunks, only a marker.

similarity: Option<u8>

similarity index of a rename or copy, in percent.

old_mode: Option<String>

new_mode: Option<String>

hunks: Vec<Hunk>

header: Vec<String>

The header lines as written (diff --git, index, ---, +++, binary data…), without line breaks; FileDiff::to_patch writes them back verbatim.

coarse: bool

The diff hit its cost cap: correct, but not necessarily the smallest.

Implementations

impl FileDiff

pub fn from_texts(old: &str, new: &str) -> FileDiff

Diffs two texts line by line with the default options.

pub fn from_texts_with(old: &str, new: &str, opts: DiffOptions) -> FileDiff

Diffs two texts line by line. The new text is kept, so every Gap is expandable.

pub fn with_paths(self, old: &str, new: &str) -> FileDiff

Sets both paths (and the ---/+++ header lines).

pub fn with_source(self, new_text: &str) -> FileDiff

Supplies the full new text of a parsed patch, so its collapsed ranges can be expanded.

pub fn path(&self) -> &str

The path to show: the new one, else the old one.

pub fn stats(&self) -> (usize, usize)

Lines added and removed.

pub fn source_len(&self) -> Option<u32>

Number of lines of the new text, when it is known.

pub fn source_line(&self, new_no: u32) -> Option<&str>

Line new_no (1-based) of the new text, without its line break, when the text is known.

pub fn gaps(&self) -> Vec<Gap>

The unchanged ranges around the hunks, in order. The range after the last hunk is listed only when the new text is known (a patch does not say how long the file is). Empty ranges are left out.

pub fn to_patch(&self) -> String

This file as a unified patch: the header lines, then the hunks.

Trait Implementations

impl Clone for FileDiff

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileDiff

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

Formats the value using the given formatter.

impl Default for FileDiff

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FileDiff

impl PartialEq for FileDiff

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileDiff