Struct Diff 

pub struct Diff {
    pub lines: Vec<DiffLine>,
    pub hunks: Vec<Hunk>,
    pub json: bool,
    pub note: Option<String>,
}

The diff of two texts: every line, and the hunks over them.

Fields

lines: Vec<DiffLine>

Every line of both texts in order: unchanged, removed and added (and, for JSON, summary) lines.

hunks: Vec<Hunk>

The changes with their context, in order. Lines outside every hunk are unchanged (Diff::gaps).

json: bool

Compared as JSON (Diff::json).

note: Option<String>

Why a JSON comparison fell back to text (a side did not parse).

Implementations

impl Diff

pub fn text(old: &str, new: &str, context: usize) -> Diff

The line diff of old and new, with context unchanged lines around each change.

pub fn json(old: &str, new: &str, context: usize, array_summary: usize) -> Diff

The diff of two JSON documents compared by key (Diff::json_values); when a side does not parse, the text diff with a Diff::note saying why.

pub fn json_values( old: &Value, new: &Value, context: usize, array_summary: usize, ) -> Diff

The diff of two JSON values: both printed with sorted keys (two-space indent), arrays longer than array_summary as one line each, then compared line by line. A changed long array becomes one LineKind::Summary line. Trailing commas are not compared, so adding a key at the end does not mark the line before it as changed.

pub fn is_empty(&self) -> bool

Whether the texts are the same.

pub fn added(&self) -> usize

Lines added (summary lines count as one added and one removed).

pub fn removed(&self) -> usize

Lines removed (summary lines count as one added and one removed).

pub fn gaps(&self) -> Vec<Range<usize>>

The unchanged runs outside the hunks, as ranges of Diff::lines: before the first hunk, between hunks and after the last (empty runs left out). gaps()[i] comes before hunks[i] when it ends where that hunk starts.

pub fn unified(&self) -> String

The diff as unified-diff text (hunk headers, then , -, + lines; a summary line as ~).

pub fn apply(&self, accepted: &[bool]) -> Option<String>

The old text with the accepted hunks applied (accepted[i] for hunks[i]; missing entries are rejected): an agent’s proposed change, reviewed. None for a JSON diff (its lines are a printout, not the document).

Trait Implementations

impl Clone for Diff

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 Diff

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

Formats the value using the given formatter.

impl Default for Diff

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Diff

impl PartialEq for Diff

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Diff