Struct similar::text::TextDiff

pub struct TextDiff<'old, 'new, 'bufs> { /* fields omitted */ }

Captures diff op codes for textual diffs

Implementations

impl<'old, 'new, 'bufs> TextDiff<'old, 'new, 'bufs>

pub fn configure() -> TextDiffConfig

Configures a text differ before diffing.

pub fn from_lines(old: &'old str, new: &'new str) -> TextDiff<'old, 'new, 'bufs>

Creates a diff of lines.

Equivalent to TextDiff::configure().diff_lines(old, new).

pub fn from_words(old: &'old str, new: &'new str) -> TextDiff<'old, 'new, 'bufs>

Creates a diff of words.

Equivalent to TextDiff::configure().diff_words(old, new).

pub fn from_chars(old: &'old str, new: &'new str) -> TextDiff<'old, 'new, 'bufs>

Creates a diff of chars.

Equivalent to TextDiff::configure().diff_chars(old, new).

pub fn from_graphemes(
    old: &'old str,
    new: &'new str
) -> TextDiff<'old, 'new, 'bufs>

Creates a diff of graphemes.

Equivalent to TextDiff::configure().diff_graphemes(old, new).

This requires the unicode feature.

pub fn from_slices(
    old: &'bufs [&'old str],
    new: &'bufs [&'new str]
) -> TextDiff<'old, 'new, 'bufs>

Creates a diff of arbitrary slices.

Equivalent to TextDiff::configure().diff_slices(old, new).

pub fn algorithm(&self) -> Algorithm

The name of the algorithm that created the diff.

pub fn newline_terminated(&self) -> bool

Returns true if items in the slice are newline terminated.

This flag is used by the unified diff writer to determine if extra newlines have to be added.

pub fn old_slices(&self) -> &[&'old str]

Returns all old slices.

pub fn new_slices(&self) -> &[&'new str]

Returns all new slices.

pub fn ratio(&self) -> f32

Return a measure of the sequences' similarity in the range 0..=1.

A ratio of 1.0 means the two sequences are a complete match, a ratio of 0.0 would indicate completely distinct sequences.

let diff = TextDiff::from_chars("abcd", "bcde");
assert_eq!(diff.ratio(), 0.75);

pub fn iter_changes(&self, op: &DiffOp) -> impl Iterator<Item = Change<'_>>

Iterates over the changes the op expands to.

This method is a convenient way to automatically resolve the different ways in which a change could be encoded (insert/delete vs replace), look up the value from the appropriate slice and also handle correct index handling.

In addition it has some custom handling to insert "virtual" newlines for diffs where TextDiff::newline_terminated is true but the diff does not end in newlines in the right places. For more information see Change::is_virtual.

pub fn ops(&self) -> &[DiffOp]

Returns the captured diff ops.

pub fn grouped_ops(&self, n: usize) -> Vec<Vec<DiffOp>>

Isolate change clusters by eliminating ranges with no changes.

This is equivalent to calling group_diff_ops on TextDiff::ops.

pub fn unified_diff<'diff>(&'diff self) -> UnifiedDiff<'diff, 'old, 'new, 'bufs>

Utility to return a unified diff formatter.