Struct DiffReport 

pub struct DiffReport<'mem, 'facet> { /* private fields */ }

A reusable diff plus its original inputs, allowing rendering in different output styles.

DiffReport holds a computed Diff along with Peek references to the original left and right values. This allows rendering the same diff in multiple formats without recomputing the diff tree.

Example

use facet::Facet;
use facet_diff::{DiffReport, diff_new_peek};
use facet_reflect::Peek;

#[derive(Facet)]
struct Point { x: i32, y: i32 }

let old = Point { x: 10, y: 20 };
let new = Point { x: 10, y: 30 };

let left = Peek::new(&old);
let right = Peek::new(&new);
let diff = diff_new_peek(left, right);

let report = DiffReport::new(diff, left, right);

// Render in different formats
println!("Rust format:\n{}", report.render_plain_rust());
println!("JSON format:\n{}", report.render_plain_json());
println!("XML format:\n{}", report.render_plain_xml());

Implementations

impl<'mem, 'facet> DiffReport<'mem, 'facet>

pub fn new( diff: Diff<'mem, 'facet>, left: Peek<'mem, 'facet>, right: Peek<'mem, 'facet>, ) -> DiffReport<'mem, 'facet>

Create a new diff report from a computed diff and the original values.

pub fn with_float_tolerance(self, tolerance: f64) -> DiffReport<'mem, 'facet>

Create a new diff report with float tolerance information.

The tolerance is used to determine appropriate decimal precision when rendering floating-point values in the diff output.

pub fn diff(&self) -> &Diff<'mem, 'facet>

Access the raw diff tree.

pub fn left(&self) -> Peek<'mem, 'facet>

Peek into the left-hand value.

pub fn right(&self) -> Peek<'mem, 'facet>

Peek into the right-hand value.

pub fn legacy_string(&self) -> String

Format the diff using the legacy tree display (same output as Display impl).

pub fn render_with_options<B, F>( &self, flavor: &F, build_opts: &BuildOptions, render_opts: &RenderOptions<B>, ) -> String

where B: ColorBackend, F: DiffFlavor,

Render the diff with a custom flavor and render/build options.

pub fn render_ansi_with<F>(&self, flavor: &F) -> String

where F: DiffFlavor,

Render using ANSI colors with the provided flavor.

pub fn render_plain_with<F>(&self, flavor: &F) -> String

where F: DiffFlavor,

Render without colors using the provided flavor.

pub fn render_ansi_rust(&self) -> String

Render using the Rust flavor with ANSI colors.

pub fn render_plain_rust(&self) -> String

Render using the Rust flavor without colors.

pub fn render_ansi_json(&self) -> String

Render using the JSON flavor with ANSI colors.

pub fn render_plain_json(&self) -> String

Render using the JSON flavor without colors.

pub fn render_ansi_xml(&self) -> String

Render using the XML flavor with ANSI colors.

pub fn render_plain_xml(&self) -> String

Render using the XML flavor without colors.