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.Expand description
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§
source§impl Summary
impl Summary
sourcepub fn with_metadata(metadata: &impl Serialize) -> Result<Summary, Error>
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
.
sourcepub fn parse(s: &str) -> Result<Summary, Error>
pub fn parse(s: &str) -> Result<Summary, 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§
source§impl<'de> Deserialize<'de> for Summary
impl<'de> Deserialize<'de> for Summary
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<Summary, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>( __deserializer: __D ) -> Result<Summary, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq<Summary> for Summary
impl PartialEq<Summary> for Summary
source§impl Serialize for Summary
impl Serialize for Summary
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. 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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more