Struct similar::algorithms::Compact

pub struct Compact<'old, 'new, Old: ?Sized, New: ?Sized, D> { /* private fields */ }

Performs semantic cleanup operations on a diff.

This merges similar ops together but also tries to move hunks up and down the diff with the desire to connect as many hunks as possible. It still needs to be combined with Replace to get actual replace diff ops out.

Implementations

impl<'old, 'new, Old, New, D> Compact<'old, 'new, Old, New, D>where
    D: DiffHook,
    Old: Index<usize> + ?Sized + 'old,
    New: Index<usize> + ?Sized + 'new,
    New::Output: PartialEq<Old::Output>,

pub fn new(d: D, old: &'old Old, new: &'new New) -> Self

Creates a new compact hook wrapping another hook.

pub fn into_inner(self) -> D

Extracts the inner hook.

Trait Implementations

impl<'old, 'new, Old: ?Sized, New: ?Sized, D: DiffHook> AsMut<D> for Compact<'old, 'new, Old, New, D>

fn as_mut(&mut self) -> &mut D

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'old, 'new, Old: ?Sized, New: ?Sized, D: DiffHook> AsRef<D> for Compact<'old, 'new, Old, New, D>

fn as_ref(&self) -> &D

Converts this type into a shared reference of the (usually inferred) input type.

impl<'old, 'new, Old: Debug + ?Sized, New: Debug + ?Sized, D: Debug> Debug for Compact<'old, 'new, Old, New, D>

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

Formats the value using the given formatter.

impl<'old, 'new, Old, New, D> DiffHook for Compact<'old, 'new, Old, New, D>where
    D: DiffHook,
    Old: Index<usize> + ?Sized + 'old,
    New: Index<usize> + ?Sized + 'new,
    New::Output: PartialEq<Old::Output>,

type Error = <D as DiffHook>::Error

The error produced from the hook methods.

fn equal(
    &mut self,
    old_index: usize,
    new_index: usize,
    len: usize
) -> Result<(), Self::Error>

Called when lines with indices old_index (in the old version) and new_index (in the new version) start an section equal in both versions, of length len.

fn delete(
    &mut self,
    old_index: usize,
    old_len: usize,
    new_index: usize
) -> Result<(), Self::Error>

Called when a section of length old_len, starting at old_index, needs to be deleted from the old version.

fn insert(
    &mut self,
    old_index: usize,
    new_index: usize,
    new_len: usize
) -> Result<(), Self::Error>

Called when a section of the new version, of length new_len and starting at new_index, needs to be inserted at position `old_index’.

fn finish(&mut self) -> Result<(), Self::Error>

Always called at the end of the algorithm.

fn replace(
    &mut self,
    old_index: usize,
    old_len: usize,
    new_index: usize,
    new_len: usize
) -> Result<(), Self::Error>

Called when a section of the old version, starting at index old_index and of length old_len, needs to be replaced with a section of length new_len, starting at new_index, of the new version.