Struct similar::text::Change

pub struct Change<'s> { /* fields omitted */ }

Represents the expanded textual change.

This type is returned from the TextDiff::iter_changes method. It exists so that it's more convenient to work with textual differences as the underlying DiffOp does not know anything about strings.

Implementations

impl<'s> Change<'s>

pub fn tag(&self) -> ChangeTag

Returns the change tag.

pub fn old_index(&self) -> Option<usize>

Returns the old index if available.

pub fn new_index(&self) -> Option<usize>

Returns the new index if available.

pub fn value(&self) -> &'s str

Returns the changed value.

pub fn is_virtual(&self) -> bool

Returns true for virtual changes.

Virtual changes are changes that do not exist in either diff but are necessary for a consistent user experience. This currently only applies to changes related to newline handling. If lines are passed to the TextDiff the TextDiff::newline_terminated flag is set in which case newlines of the input are included in the changes. However if the trailing newline is missing it would mess up processing greatly. Because of this a trailing virtual newline is automatically added for a more consistent user experience. This virtual newline can be detected by explicitly checking for this flag.

Trait Implementations

impl<'s> Clone for Change<'s>

fn clone(&self) -> Change<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Copy for Change<'s>

impl<'s> Debug for Change<'s>

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

Formats the value using the given formatter.

impl<'s> Eq for Change<'s>

impl<'s> Hash for Change<'s>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'s> Ord for Change<'s>

fn cmp(&self, other: &Change<'s>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'s> PartialEq<Change<'s>> for Change<'s>

fn eq(&self, other: &Change<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Change<'s>) -> bool

This method tests for !=.

impl<'s> PartialOrd<Change<'s>> for Change<'s>

fn partial_cmp(&self, other: &Change<'s>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Change<'s>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Change<'s>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Change<'s>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Change<'s>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'s> StructuralEq for Change<'s>

impl<'s> StructuralPartialEq for Change<'s>