Struct SummaryDiff

pub struct SummaryDiff<'a> {
    pub target_packages: PackageDiff<'a>,
    pub host_packages: PackageDiff<'a>,
}

A diff of two package summaries.

This struct contains information on the packages that were changed, as well as those that were not.

Human-readable reports

The report method can be used with fmt::Display to generate a friendly, human-readable report.

Machine-readable serialization

A SummaryDiff can be serialized through serde. The output format is part of the API.

An example of TOML-serialized output:

[[target-packages.changed]]
name = "dep"
version = "0.4.3"
crates-io = true
change = "added"
status = "direct"
features = ["std"]

[[target-packages.changed]]
name = "foo"
version = "1.2.3"
workspace-path = "foo"
change = "modified"
new-status = "initial"
added-features = ["feature2"]
removed-features = []
unchanged-features = ["default", "feature1"]

[[target-packages.unchanged]]
name = "no-changes"
version = "1.5.3"
crates-io = true
status = "transitive"
features = ["default"]

[[host-packages.changed]]
name = "dep"
version = "0.4.2"
crates-io = true
change = "removed"
old-status = "direct"
old-features = ["std"]

Fields

target_packages: PackageDiff<'a>

Diff of target packages.

host_packages: PackageDiff<'a>

Diff of host packages.

Implementations

impl<'a> SummaryDiff<'a>

pub fn new(old: &'a Summary, new: &'a Summary) -> Self

Computes a diff between two summaries.

pub fn is_changed(&self) -> bool

Returns true if there are any changes in this diff.

pub fn is_unchanged(&self) -> bool

Returns true if there are no changes in this diff.

pub fn report<'b>(&'b self) -> SummaryReport<'a, 'b>

Returns a report for this diff.

This report can be used with fmt::Display.

Trait Implementations

impl<'a> Clone for SummaryDiff<'a>

fn clone(&self) -> SummaryDiff<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SummaryDiff<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for SummaryDiff<'a>

fn eq(&self, other: &SummaryDiff<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for SummaryDiff<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for SummaryDiff<'a>

impl<'a> StructuralPartialEq for SummaryDiff<'a>