Skip to main content

DiffNode

tiny_diff

Trait DiffNode 

Source 
pub trait DiffNode: Sized {
    type Key: Eq + Hash;
    type Modifications;

    // Required methods
    fn key(&self) -> &Self::Key;
    fn path(&self) -> &[u32];
    fn children(&self) -> &[Self];
    fn compatible(&self, previous: &Self) -> bool;
    fn modifications(&self, previous: &Self) -> Option<Self::Modifications>;

    // Provided methods
    fn diff(
        &self,
        previous: Option<&Self>,
        diff: &mut Diff<Self::Modifications>,
    ) { ... }
    fn validate_children(&self) { ... }
}
Expand description

A tree node with stable sibling keys and index-based paths. Children must expose paths extending their parent’s path by their child index.

Required Associated Types§

Source

type Key: Eq + Hash

Source

type Modifications

Required Methods§

Source

fn key(&self) -> &Self::Key

Source

fn path(&self) -> &[u32]

Source

fn children(&self) -> &[Self]

Source

fn compatible(&self, previous: &Self) -> bool

Whether these nodes have compatible kinds, independently of their keys.

Source

fn modifications(&self, previous: &Self) -> Option<Self::Modifications>

Returns changes for compatible nodes with matching keys, or None if unchanged.

Provided Methods§

Source

fn diff(&self, previous: Option<&Self>, diff: &mut Diff<Self::Modifications>)

Appends changes from previous to self into diff. Matching roots must have paths of equal depth and corresponding parents.

Examples found in repository?
examples/demo.rs (line 69)
56fn main() {
57    let previous = list(&[
58        ("apple", "Apple"),
59        ("banana", "Banana"),
60        ("cherry", "Cherry"),
61    ]);
62    let current = list(&[
63        ("banana", "Ripe banana"),
64        ("orange", "Orange"),
65        ("apple", "Apple"),
66    ]);
67
68    let mut changes = Diff::default();
69    current.diff(Some(&previous), &mut changes);
70
71    println!("Added at new paths: {:?}", changes.added);
72    println!("Removed at old paths: {:?}", changes.removed);
73    println!("New text at new paths: {:?}", changes.modified);
74    println!(
75        "Old/new child indices by new parent path: {:?}",
76        changes.moved
77    );
78}
Source

fn validate_children(&self)

Checks application-specific sibling key rules before matching children in debug builds.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§