Struct similar::algorithms::Capture

pub struct Capture(_);

A DiffHook that captures all diff operations.

Implementations

impl Capture

pub fn new() -> Capture

Creates a new capture hook.

pub fn into_ops(self) -> Vec<DiffOp>

Converts the capture hook into a vector of ops.

pub fn into_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 Capture::into_ops.

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

Accesses the captured operations.

Trait Implementations

impl Clone for Capture

fn clone(&self) -> Capture

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Capture

fn default() -> Capture

Returns the “default value” for a type.

impl DiffHook for Capture

type Error = Infallible

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 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.

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

Always called at the end of the algorithm.