Struct guppy::graph::summaries::Summary

pub struct Summary {
    pub metadata: Map<String, Value>,
    pub target_packages: BTreeMap<SummaryId, PackageInfo, Global>,
    pub host_packages: BTreeMap<SummaryId, PackageInfo, Global>,
}

Available on crate feature summaries only.

An in-memory representation of a build summary.

The metadata parameter is customizable.

For more, see the crate-level documentation.

Fields

metadata: Map<String, Value>

Extra metadata associated with the summary.

This may be used for storing extra information about the summary.

The type defaults to toml::Value but is customizable.

target_packages: BTreeMap<SummaryId, PackageInfo, Global>

The packages and features built on the target platform.

host_packages: BTreeMap<SummaryId, PackageInfo, Global>

The packages and features built on the host platform.

Implementations

impl Summary

pub fn with_metadata(metadata: &impl Serialize) -> Result<Summary, Error>

Constructs a new summary with the provided metadata, and an empty target_packages and host_packages.

pub fn parse(s: &str) -> Result<Summary, Error>

Deserializes a summary from the given string, with optional custom metadata.

pub fn diff<'a>(&'a self, other: &'a Summary) -> SummaryDiff<'a>

Perform a diff of this summary against another.

This doesn’t diff the metadata, just the initials and packages.

pub fn to_string(&self) -> Result<String, Error>

Serializes this summary to a TOML string.

pub fn write_to_string(&self, dst: &mut String) -> Result<(), Error>

Serializes this summary into the given TOML string, using pretty TOML syntax.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Summary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Summary

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Summary, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Summary> for Summary

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Summary

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Summary