Struct natural_xml_diff::NaturalXmlDiff

pub struct NaturalXmlDiff<'a> { /* private fields */ }

A natural XML diff comparison of two documents.

Implementations

impl<'a> NaturalXmlDiff<'a>

pub fn new(xml_a: &str, xml_b: &str) -> Result<Self, Error>

Construct a comparison between two XML documents from XML strings.

Examples found in repository

src/convenience.rs (line 161)

pub fn diff(xml_a: &str, xml_b: &str) -> Result<String, Error> {
    let mut nxd = NaturalXmlDiff::new(xml_a, xml_b)?;
    Ok(nxd.diff())
}

pub fn diff(&mut self) -> String

Returns a diff document for this comparison.

This diff document contains information on how to change document A into document B. If this diff document is applied using apply, the result should be semantically equivalent to document B.

Examples found in repository

src/convenience.rs (line 162)

pub fn diff(xml_a: &str, xml_b: &str) -> Result<String, Error> {
    let mut nxd = NaturalXmlDiff::new(xml_a, xml_b)?;
    Ok(nxd.diff())
}

pub fn verify(&mut self) -> Result<(), String>

Verify that a correct diff gets produced in one step.

This is a convenience function that first constructs the diff document and then immediately applies it to document A and checks that the result is semantically equal to document B. If not, it returns the XML for the erroneous document as part of the error.

It’s useful for testing purposes if you want to ensure that correct diffs are produced.

pub fn edits(&mut self) -> Vec<Edit>

Returns a list of edits that transform document A into document B.

This is a low-level API to see the details of the edit operations. Normally you’d use the higher level NaturalXmlDiff::diff method to obtain the diff document.

pub fn partition(&mut self) -> Vec<(Range<usize>, Range<usize>)>

Returns a list of partitions of a and b where nodes are equal.

A low-level API to see the details of the diffing algorithm.

pub fn diff_status(
    &mut self
) -> (impl Iterator<Item = (Node, Status)> + '_, impl Iterator<Item = (Node, Status)> + '_)

Returns an iterator of nodes in document a and b and their status.

A low-level API to see the details of the diffing algorithm.

pub fn serialize(&mut self, node: Node) -> String

Serialize a node to a string.

You can get a node if you access the edits and have an InsertContent::XmlNode

pub fn xot(&self) -> &Xot<'_>

Access to the low-level Xot instance - this is useful if you need access to XML values and names.

Normally should not be needed if you stick to the high-level API.