Struct similar::Change

pub struct Change<T> { /* private fields */ }

Represents the expanded DiffOp change.

This type is returned from DiffOp::iter_changes and TextDiff::iter_changes.

It exists so that it’s more convenient to work with textual differences as the underlying DiffOp encodes a group of changes.

This type has additional methods that are only available for types implementing DiffableStr.

Implementations

impl<'s, T: DiffableStr + ?Sized> Change<&'s T>

The text interface can produce changes over DiffableStr implementing values. As those are generic interfaces for different types of strings utility methods to make working with standard rust strings more enjoyable.

pub fn as_str(&self) -> Option<&'s str>

Returns the value as string if it is utf-8.

pub fn to_string_lossy(&self) -> Cow<'s, str>

Returns the value (lossy) decoded as utf-8 string.

pub fn missing_newline(&self) -> bool

Returns true if this change does not end in a newline and must be followed up by one if line based diffs are used.

The std::fmt::Display implementation of Change will automatically insert a newline after the value if this is true.

impl<T: Clone> Change<T>

These methods are available for all change types.

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) -> T

Returns the underlying changed value.

Depending on the type of the underlying crate::text::DiffableStr this value is more or less useful. If you always want to have a utf-8 string it’s best to use the Change::as_str and Change::to_string_lossy methods.

pub fn value_ref(&self) -> &T

Returns the underlying changed value as reference.

pub fn value_mut(&mut self) -> &mut T

Returns the underlying changed value as mutable reference.

Trait Implementations

impl<T: Clone> Clone for Change<T>

fn clone(&self) -> Change<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Change<T>

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

Formats the value using the given formatter.

impl<'s, T: DiffableStr + ?Sized> Display for Change<&'s T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Change<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Change<T>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Change<T>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Change<T>

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<T: Copy> Copy for Change<T>

impl<T: Eq> Eq for Change<T>

impl<T> StructuralPartialEq for Change<T>