Skip to main content

DiffReport

Struct DiffReport 

Source
pub struct DiffReport {
    pub before: String,
    pub after: String,
    pub added: Vec<String>,
    pub removed: Vec<String>,
    pub renamed: Vec<(String, String)>,
    pub content_changed: Vec<String>,
    pub frontmatter_changed: Vec<String>,
    pub trust_changed: Vec<TrustMove>,
    pub links_broken: Vec<(String, String)>,
    pub links_mended: Vec<(String, String)>,
}
Expand description

What changed between two bundles, semantically rather than by bytes.

ADR-0021 made render okf byte-deterministic specifically so “a consumer can diff two downloads and learn something”. This is that diff, and it is the first thing in the workspace to exercise the determinism: review --base diffs code, not bundles.

A rename is the interesting field. A textual diff of two bundles reports a moved concept as one deletion and one unrelated addition; this reports it as a rename, which is the difference between “we lost a concept” and “we moved one”.

Fields§

§before: String

The bundle taken as “before”.

§after: String

The bundle taken as “after”.

§added: Vec<String>

Concepts present only in after.

§removed: Vec<String>

Concepts present only in before.

§renamed: Vec<(String, String)>

Concepts whose path changed, as (from, to).

§content_changed: Vec<String>

Concepts whose body changed.

§frontmatter_changed: Vec<String>

Concepts whose frontmatter keys changed.

§trust_changed: Vec<TrustMove>

Concepts whose tier or status moved. The one to read first.

§links_broken: Vec<(String, String)>

Links that broke between before and after, as (concept, target).

§links_mended: Vec<(String, String)>

Links that were broken in before and resolve in after.

Implementations§

Source§

impl DiffReport

Source

pub fn is_unchanged(&self) -> bool

true when the two bundles are semantically identical.

Trait Implementations§

Source§

impl Clone for DiffReport

Source§

fn clone(&self) -> DiffReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DiffReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for DiffReport

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.