Struct serde_diff::Config

pub struct Config { /* fields omitted */ }

Configures creation of Apply and Diff

Examples

use serde_diff::{SerdeDiff, Config, FieldPathMode};
use serde::{Serialize, Deserialize};
#[derive(SerdeDiff, Serialize, Deserialize, PartialEq)]
struct Test {
    a: i32,
}
let diff = Config::new()
    .with_field_path_mode(FieldPathMode::Index)
    .serializable_diff(&Test { a: 3 }, &Test { a: 5 });

Implementations

impl Config

pub fn new() -> Self

Creates a Config with default values

pub fn with_field_path_mode(mut self: Self, mode: FieldPathMode) -> Self

Sets the FieldPathMode to use when serializing a Diff

pub fn serializable_diff<'a, 'b, T: SerdeDiff + 'a + 'b>(
    self,
    old: &'a T,
    new: &'b T
) -> Diff<'a, 'b, T>

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<'a, 'b, S: Serializer, T: SerdeDiff + 'a + 'b>(
    self,
    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 deserializable_apply<'a, T: SerdeDiff>(
    self,
    target: &'a mut T
) -> Apply<'a, T>

Create a deserializable Apply, where the given target will be changed when the resulting Apply struct is deserialized

pub fn apply<'de, D, T: SerdeDiff>(
    self,
    deserializer: D,
    target: &mut T
) -> Result<(), <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Applies a sequence of diff commands to the target, as read by the deserializer

Trait Implementations

impl Default for Config

pub fn default() -> Self

Returns the "default value" for a type.