Struct guppy_summaries::SummaryWithMetadata

pub struct SummaryWithMetadata<M = Value> {
    pub metadata: Option<M>,
    pub target_packages: PackageMap,
    pub host_packages: PackageMap,
}

An in-memory representation of a build summary.

The metadata parameter is customizable.

For more, see the crate-level documentation.

Fields

metadata: Option<M>

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: PackageMap

The packages and features built on the target platform.

host_packages: PackageMap

The packages and features built on the host platform.

Implementations

impl<M> SummaryWithMetadata<M>

pub fn parse<'de>(s: &'de str) -> Result<Self, Error> where
    M: Deserialize<'de>, 

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

pub fn diff<'a, M2>(
    &'a self,
    other: &'a SummaryWithMetadata<M2>
) -> 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> where
    M: Serialize, 

Serializes this summary to a TOML string.

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

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

Trait Implementations

impl<M: Clone> Clone for SummaryWithMetadata<M>

fn clone(&self) -> SummaryWithMetadata<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for SummaryWithMetadata<M>

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

Formats the value using the given formatter.

impl<M> Default for SummaryWithMetadata<M>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, M> Deserialize<'de> for SummaryWithMetadata<M> where
    M: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<M: Eq> Eq for SummaryWithMetadata<M>

impl<M: Hash> Hash for SummaryWithMetadata<M>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<M: PartialEq> PartialEq<SummaryWithMetadata<M>> for SummaryWithMetadata<M>

fn eq(&self, other: &SummaryWithMetadata<M>) -> bool

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

fn ne(&self, other: &SummaryWithMetadata<M>) -> bool

This method tests for !=.

impl<M> Serialize for SummaryWithMetadata<M> where
    M: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<M> StructuralEq for SummaryWithMetadata<M>

impl<M> StructuralPartialEq for SummaryWithMetadata<M>