Struct VersionInfo 

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

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");

If deserialization succeeds, it is guaranteed that there is only one root package, and that are no cyclic dependencies.

Fields

packages: Vec<Package>

format: u32

Format revision. Identifies the data source for the audit data.

Format revisions are backwards compatible. If an unknown format is encountered, it should be treated as the highest known preceding format. For example, if formats 0, 1 and 8 are known, format 4 should be treated as if it’s 1.

Known formats

0 (or the field is absent)

Generated based on the data provided by cargo metadata.

There are multiple known issues with this data source, leading to the audit data sometimes including more dependencies than are really used in the build.

However, is the only machine-readable data source available on stable Rust as of v1.88.

Additionally, this format incorrectly includes procedural macros and their dependencies as runtime dependencies while in reality they are build-time dependencies.

1

Same as 0, but correctly records proc-macros and their dependencies as build-time dependencies.

May still include slightly more dependencies than are actually used, especially in workspaces.

8

Generated using Cargo’s SBOM precursor as the data source.

This data is highly accurate, but as of Rust v1.88 can only be generated using a nightly build of Cargo.

Trait Implementations

impl Clone for VersionInfo

fn clone(&self) -> VersionInfo

Returns a duplicate 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 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 JsonSchema for VersionInfo

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for VersionInfo

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VersionInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 Eq for VersionInfo

impl StructuralPartialEq for VersionInfo