Struct Diff 

pub struct Diff { /* private fields */ }

Available on crate feature blob only.

Represents the difference between two sequences of tokens.

A Diff stores which tokens were removed from the first sequence and which tokens were added to the second sequence.

Implementations

impl Diff

pub fn postprocess_with( &mut self, before: &[Token], after: &[Token], heuristic: impl SliderHeuristic, )

Postprocesses the diff using explicit token sequences and a custom heuristic.

This is a lower-level method that works directly with token sequences rather than an InternedInput. Use postprocess_with_heuristic for a more convenient API.

Parameters

• before - The token sequence from the first file, before changes
• after - The token sequence from the second file, after changes
• heuristic - The slider heuristic to use for positioning hunks

pub fn postprocess_with_heuristic<T>( &mut self, input: &InternedInput<T>, heuristic: impl SliderHeuristic, )

Postprocesses the diff using an InternedInput and a custom heuristic.

This is a convenience wrapper around postprocess_with that extracts the token sequences from the input automatically.

Parameters

• input - The interned input containing the token sequences
• heuristic - The slider heuristic to use for positioning hunks

impl Diff

pub fn compute<T>(algorithm: Algorithm, input: &InternedInput<T>) -> Diff

Computes an edit-script that transforms input.before into input.after using the specified algorithm

pub fn compute_with( &mut self, algorithm: Algorithm, before: &[Token], after: &[Token], num_tokens: u32, )

Computes an edit-script that transforms before into after using the specified algorithm.

pub fn count_additions(&self) -> u32

Returns the total number of tokens that were added in the second sequence.

pub fn count_removals(&self) -> u32

Returns the total number of tokens that were removed from the first sequence (before).

pub fn is_removed(&self, token_idx: u32) -> bool

Returns true if the token at the given index was removed from the first sequence (before).

Panics

Panics if token_idx is out of bounds for the first sequence.

pub fn is_added(&self, token_idx: u32) -> bool

Returns true if the token at the given index was added to the second sequence (after).

Panics

Panics if token_idx is out of bounds for the second sequence (after).

pub fn postprocess_no_heuristic<T>(&mut self, input: &InternedInput<T>)

Postprocesses the diff to make it more human-readable. Certain hunks have an ambiguous placement (even in a minimal diff) where they can move downward or upward by removing a token (line) at the start and adding one at the end (or the other way around). The postprocessing adjusts these hunks according to a couple of rules:

• Always merge multiple hunks if possible.
• Always try to create a single MODIFY hunk instead of multiple disjoint ADDED/REMOVED hunks.
• Move sliders as far down as possible.

pub fn postprocess_lines<T>(&mut self, input: &InternedInput<T>)

where T: AsRef<[u8]>,

Postprocesses the diff to make it more human-readable. Certain hunks have an ambiguous placement (even in a minimal diff) where they can move downward or upward by removing a token (line) at the start and adding one at the end (or the other way around). The postprocessing adjusts these hunks according to a couple of rules:

• Always merge multiple hunks if possible.
• Always try to create a single MODIFY hunk instead of multiple disjoint ADDED/REMOVED hunks.
• Based on a line’s indentation level, heuristically compute the most intuitive location to split lines.
• Move sliders as far down as possible.

pub fn hunks(&self) -> HunkIter<'_>

Return an iterator that yields the changed hunks in this diff.

Trait Implementations

impl Debug for Diff

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

Formats the value using the given formatter.

impl Default for Diff

fn default() -> Diff

Returns the “default value” for a type.