Struct serde_diff::Diff

pub struct Diff<'a, 'b, T> { /* fields omitted */ }

A serializable structure that will produce a sequence of diff commands when serialized. You can pass this to a serializer, or use the convenience method diff to pass your serializer along with old/new values to use when serializing the diff.

Examples

use serde_diff::{SerdeDiff, Diff};
use serde::{Serialize, Deserialize};
#[derive(SerdeDiff, Serialize, Deserialize, PartialEq)]
struct Test {
    a: i32,
}
let diff = Diff::serializable(&Test { a: 3 }, &Test { a: 5 });

Implementations

impl<'a, 'b, T: SerdeDiff + 'a + 'b> Diff<'a, 'b, T>

pub fn serializable(old: &'a T, new: &'b T) -> Self

Create a serializable Diff, which when serialized will write the differences between the old and new value into the serializer in the form of a sequence of diff commands

pub fn diff<S: Serializer>(
    serializer: S,
    old: &'a T,
    new: &'b T
) -> Result<S::Ok, S::Error>

Writes the differences between the old and new value into the given serializer in the form of a sequence of diff commands

pub fn has_changes(&self) -> bool

True if a change was detected during the diff

Trait Implementations

impl<'a, 'b, T: SerdeDiff> Serialize for Diff<'a, 'b, T>

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

Serialize this value into the given Serde serializer.