Skip to main content

CycloneDxSbom

Struct CycloneDxSbom 

Source
pub struct CycloneDxSbom {
    pub bom_format: String,
    pub spec_version: String,
    pub serial_number: String,
    pub version: u32,
    pub metadata: SbomMetadata,
    pub components: Vec<Component>,
    pub dependencies: Vec<Dependency>,
}
Expand description

A complete CycloneDX 1.5 SBOM document.

Field names use #[serde(rename_all = "camelCase")] to match the CycloneDX JSON schema (bomFormat, specVersion, serialNumber, …).

Fields§

§bom_format: String

Always the literal string "CycloneDX".

§spec_version: String

CycloneDX spec version — "1.5".

§serial_number: String

urn:uuid:... serial number, derived from the output ELF digest.

§version: u32

Document revision; 1 for a freshly emitted SBOM.

§metadata: SbomMetadata

Build metadata: timestamp + the synth compiler tool entry.

§components: Vec<Component>

Components: the input WASM, the output ELF, and one per WASM import.

§dependencies: Vec<Dependency>

Dependency graph linking the output ELF to its inputs.

Implementations§

Source§

impl CycloneDxSbom

Source

pub fn new(inputs: &SbomInputs<'_>, timestamp: String) -> Self

Build a CycloneDX 1.5 SBOM describing one synth compilation.

timestamp is the RFC-3339 UTC string for metadata.timestamp; the caller supplies it so tests can pin a fixed value and production code can pass now_rfc3339.

Source

pub fn to_json(&self) -> String

Serialise to pretty-printed CycloneDX 1.5 JSON.

Source

pub fn sidecar_path(elf_path: &Path) -> PathBuf

Compute the SBOM path next to an output ELF: replaces the file extension with .cdx.json (the conventional CycloneDX-JSON suffix). Examples:

  • foo.elf -> foo.cdx.json
  • out -> out.cdx.json

Trait Implementations§

Source§

impl Clone for CycloneDxSbom

Source§

fn clone(&self) -> CycloneDxSbom

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CycloneDxSbom

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for CycloneDxSbom

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.