Struct Report 

pub struct Report {
    pub old: Side,
    pub new: Side,
    pub removed: Vec<Removed>,
    pub renamed: Vec<Renamed>,
    pub added: Vec<Added>,
    pub unused: Vec<Unused>,
}

The result of crate::diff. Every list is sorted.

Fields

old: Side

new: Side

removed: Vec<Removed>

IDs of the old world that the new one lacks and that no rename pairs, by kind and ID.

renamed: Vec<Renamed>

Removed IDs paired with an ID of the new world, by kind, old ID and new ID.

added: Vec<Added>

IDs of the new world that the old one lacks and that no rename pairs, by kind and ID.

unused: Vec<Unused>

Allowlist entries that did not apply, by kind and old ID.

Implementations

impl Report

pub fn breaking(&self) -> bool

Whether an ID was removed or renamed without the allowlist accepting it.

pub fn not_allowed(&self) -> usize

The removed and renamed IDs the allowlist does not accept.

pub fn to_json(&self) -> String

The report as one line of JSON in the tilewright.diff/1 format, with a final newline. Every control character in a string is escaped, so the output is safe to print to a terminal.

pub fn to_text(&self) -> String

The report as text: one line per removed, renamed and added ID, one per unused allowlist entry, and a summary line. IDs are identifiers, so no line carries control characters.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Report

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Report

impl PartialEq for Report

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Report