Struct similar::InlineChange

pub struct InlineChange<'s, T: DiffableStr + ?Sized> { /* private fields */ }

Represents the expanded textual change with inline highlights.

This is like Change but with inline highlight info.

Implementations

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

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 values(&self) -> &[(bool, &'s T)]

Returns the changed values.

Each item is a tuple in the form (emphasized, value) where emphasized is true if it should be highlighted as an inline diff.

Depending on the type of the underlying DiffableStr this value is more or less useful. If you always want to have a utf-8 string it’s better to use the InlineChange::iter_strings_lossy method.

pub fn iter_strings_lossy(&self) -> impl Iterator<Item = (bool, Cow<'_, str>)>

Iterates over all (potentially lossy) utf-8 decoded values.

Each item is a tuple in the form (emphasized, value) where emphasized is true if it should be highlighted as an inline diff.

By default, words are split by whitespace, which results in coarser diff. For example: "f(x) y" is tokenized as ["f(x)", "y"].

If you want it to be tokenized instead as ["f(", "x", ")"], you should enable the "unicode" flag.

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.

Trait Implementations

impl<'s, T: Clone + DiffableStr + ?Sized> Clone for InlineChange<'s, T>

fn clone(&self) -> InlineChange<'s, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s, T: Debug + DiffableStr + ?Sized> Debug for InlineChange<'s, T>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn from(change: Change<&'s T>) -> InlineChange<'s, T>

Converts to this type from the input type.

impl<'s, T: Hash + DiffableStr + ?Sized> Hash for InlineChange<'s, 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<'s, T: Ord + DiffableStr + ?Sized> Ord for InlineChange<'s, T>

fn cmp(&self, other: &InlineChange<'s, 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<'s, T: PartialEq + DiffableStr + ?Sized> PartialEq for InlineChange<'s, T>

fn eq(&self, other: &InlineChange<'s, 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<'s, T: PartialOrd + DiffableStr + ?Sized> PartialOrd for InlineChange<'s, T>

fn partial_cmp(&self, other: &InlineChange<'s, 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<'s, T: Eq + DiffableStr + ?Sized> Eq for InlineChange<'s, T>

impl<'s, T: DiffableStr + ?Sized> StructuralPartialEq for InlineChange<'s, T>