Change

Struct Change

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

Expand description

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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

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<T: Hash> Hash for Change<T>

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

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

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

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

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<T> Serialize for Change<T>
where T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

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

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

impl<T> StructuralPartialEq for Change<T>

Auto Trait Implementations§

impl<T> Freeze for Change<T>
where T: Freeze,

impl<T> RefUnwindSafe for Change<T>
where T: RefUnwindSafe,

impl<T> Send for Change<T>
where T: Send,

impl<T> Sync for Change<T>
where T: Sync,

impl<T> Unpin for Change<T>
where T: Unpin,

impl<T> UnwindSafe for Change<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.