Struct auditable_serde::VersionInfo

pub struct VersionInfo {
    pub packages: Vec<Package>,
}

Dependency tree embedded in the binary.

Implements Serialize and Deserialize traits from serde, so you can use all the usual methods from serde-json to read and write it.

from_str() that parses JSON is also implemented for your convenience:

use auditable_serde::VersionInfo;
use std::str::FromStr;
let json_str = r#"{"packages":[{
    "name":"adler",
    "version":"0.2.3",
    "source":"registry"
}]}"#;
let info = VersionInfo::from_str(json_str).unwrap();
assert_eq!(&info.packages[0].name, "adler");

Optional features

If the from_metadata feature is enabled, a conversion from cargo_metadata::Metadata is possible via the TryFrom trait. This is the preferred way to construct this structure. An example demonstrating that can be found here.

If the toml feature is enabled, a conversion into the cargo_lock::Lockfile struct is possible via the TryFrom trait. This can be useful if you need to interoperate with tooling that consumes the Cargo.lock file format. An example demonstrating it can be found here.

Fields

packages: Vec<Package>

Trait Implementations

impl Clone for VersionInfo

fn clone(&self) -> VersionInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionInfo

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

Deserialize this value from the given Serde deserializer.

impl Eq for VersionInfo

impl FromStr for VersionInfo

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for VersionInfo

fn cmp(&self, other: &VersionInfo) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<VersionInfo> for VersionInfo

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

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

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

This method tests for !=.

impl PartialOrd<VersionInfo> for VersionInfo

fn partial_cmp(&self, other: &VersionInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &VersionInfo) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &VersionInfo) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &VersionInfo) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &VersionInfo) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VersionInfo

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

Serialize this value into the given Serde serializer.

impl StructuralEq for VersionInfo

impl StructuralPartialEq for VersionInfo

impl<'_> TryFrom<&'_ Metadata> for VersionInfo

type Error = InsufficientMetadata

The type returned in the event of a conversion error.

fn try_from(metadata: &Metadata) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ VersionInfo> for Lockfile

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: &VersionInfo) -> Result<Self, Self::Error>

Performs the conversion.