Skip to main content

Sbom

Struct Sbom 

Source
pub struct Sbom {
    pub metadata: Metadata,
    pub components: IndexMap<ComponentId, Component>,
    pub dependencies: BTreeMap<ComponentId, BTreeSet<ComponentId>>,
}
Expand description

Format-agnostic SBOM (Software Bill of Materials) representation.

This is the central type that holds all components and their relationships. It abstracts over format-specific details from CycloneDX, SPDX, and other formats.

§Example

use sbom_model::{Sbom, Component};

let mut sbom = Sbom::default();
let component = Component::new("serde".into(), Some("1.0.0".into()));
sbom.components.insert(component.id.clone(), component);

Fields§

§metadata: Metadata

Document-level metadata (creation time, tools, authors).

§components: IndexMap<ComponentId, Component>

All components indexed by their stable identifier.

§dependencies: BTreeMap<ComponentId, BTreeSet<ComponentId>>

Dependency graph as adjacency list: parent -> set of children.

Implementations§

Source§

impl Sbom

Source

pub fn normalize(&mut self)

Normalizes the SBOM for deterministic comparison.

This method:

  • Sorts components by ID
  • Deduplicates and sorts licenses within each component
  • Lowercases hash algorithms and values
  • Clears volatile metadata (timestamps, tools, authors)

Call this before comparing two SBOMs to ignore irrelevant differences.

Source

pub fn roots(&self) -> Vec<ComponentId>

Returns root components (those not depended on by any other component).

These are typically the top-level packages or applications in the SBOM.

Source

pub fn deps(&self, id: &ComponentId) -> Vec<ComponentId>

Returns direct dependencies of the given component.

Source

pub fn rdeps(&self, id: &ComponentId) -> Vec<ComponentId>

Returns reverse dependencies (components that depend on the given component).

Source

pub fn transitive_deps(&self, id: &ComponentId) -> BTreeSet<ComponentId>

Returns all transitive dependencies of the given component.

Traverses the dependency graph depth-first and returns all reachable components.

Source

pub fn ecosystems(&self) -> BTreeSet<String>

Returns all unique ecosystems present in the SBOM.

Source

pub fn licenses(&self) -> BTreeSet<String>

Returns all unique licenses present across all components.

Source

pub fn missing_hashes(&self) -> Vec<ComponentId>

Returns components that have no checksums/hashes.

Useful for identifying components that may need integrity verification.

Source

pub fn by_purl(&self, purl: &str) -> Option<&Component>

Finds a component by its package URL.

Trait Implementations§

Source§

impl Clone for Sbom

Source§

fn clone(&self) -> Sbom

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sbom

Source§

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

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

impl Default for Sbom

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Sbom

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Sbom

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Sbom

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
Source§

impl Eq for Sbom

Source§

impl StructuralPartialEq for Sbom

Auto Trait Implementations§

§

impl Freeze for Sbom

§

impl RefUnwindSafe for Sbom

§

impl Send for Sbom

§

impl Sync for Sbom

§

impl Unpin for Sbom

§

impl UnwindSafe for Sbom

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,