Struct guppy_summaries::Summary
source · [−]pub struct Summary {
pub metadata: Table,
pub target_packages: PackageMap,
pub host_packages: PackageMap,
}
Expand description
An in-memory representation of a build summary.
The metadata parameter is customizable.
For more, see the crate-level documentation.
Fields
metadata: Table
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
sourceimpl Summary
impl Summary
sourcepub fn with_metadata(metadata: &impl Serialize) -> Result<Self, Error>
pub fn with_metadata(metadata: &impl Serialize) -> Result<Self, Error>
Constructs a new summary with the provided metadata, and an empty target_packages
and
host_packages
.
sourcepub fn parse(s: &str) -> Result<Self, Error>
pub fn parse(s: &str) -> Result<Self, Error>
Deserializes a summary from the given string, with optional custom metadata.
sourcepub fn diff<'a>(&'a self, other: &'a Summary) -> SummaryDiff<'a>
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.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Summary
impl<'de> Deserialize<'de> for Summary
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Summary
Auto Trait Implementations
impl RefUnwindSafe for Summary
impl Send for Summary
impl Sync for Summary
impl Unpin for Summary
impl UnwindSafe for Summary
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more