Skip to main content

NormalizedSbom

Struct NormalizedSbom 

Source
pub struct NormalizedSbom {
    pub document: DocumentMetadata,
    pub components: IndexMap<CanonicalId, Component>,
    pub edges: Vec<DependencyEdge>,
    pub extensions: FormatExtensions,
    pub content_hash: u64,
    pub primary_component_id: Option<CanonicalId>,
    pub collision_count: usize,
}
Expand description

Normalized SBOM document - the canonical intermediate representation.

This structure represents an SBOM in a format-agnostic way, allowing comparison between CycloneDX and SPDX documents.

Fields§

§document: DocumentMetadata

Document-level metadata

§components: IndexMap<CanonicalId, Component>

Components indexed by canonical ID

§edges: Vec<DependencyEdge>

Dependency edges

§extensions: FormatExtensions

Format-specific extensions

§content_hash: u64

Content hash for quick equality checks

§primary_component_id: Option<CanonicalId>

Primary/root product component (CycloneDX metadata.component or SPDX documentDescribes) This identifies the main product that this SBOM describes, important for CRA compliance.

§collision_count: usize

Number of canonical ID collisions encountered during parsing

Implementations§

Source§

impl NormalizedSbom

Source

pub fn new(document: DocumentMetadata) -> Self

Create a new empty normalized SBOM

Source

pub fn add_component(&mut self, component: Component) -> bool

Add a component to the SBOM.

Returns true if a collision occurred (a component with the same canonical ID was already present and has been overwritten). Collisions are logged as warnings.

Source

pub fn log_collision_summary(&self)

Log a single summary line if any canonical ID collisions occurred during parsing.

Source

pub fn add_edge(&mut self, edge: DependencyEdge)

Add a dependency edge

Source

pub fn get_component(&self, id: &CanonicalId) -> Option<&Component>

Get a component by canonical ID

Source

pub fn get_dependencies(&self, id: &CanonicalId) -> Vec<&DependencyEdge>

Get dependencies of a component

Source

pub fn get_dependents(&self, id: &CanonicalId) -> Vec<&DependencyEdge>

Get dependents of a component

Source

pub fn calculate_content_hash(&mut self)

Calculate and update the content hash

Source

pub fn component_count(&self) -> usize

Get total component count

Source

pub fn primary_component(&self) -> Option<&Component>

Get the primary/root product component if set

Source

pub fn set_primary_component(&mut self, id: CanonicalId)

Set the primary component by its canonical ID

Source

pub fn ecosystems(&self) -> Vec<&Ecosystem>

Get all unique ecosystems in the SBOM

Source

pub fn all_vulnerabilities(&self) -> Vec<(&Component, &VulnerabilityRef)>

Get all vulnerabilities across all components

Source

pub fn vulnerability_counts(&self) -> VulnerabilityCounts

Count vulnerabilities by severity

Source

pub fn build_index(&self) -> NormalizedSbomIndex

Build an index for this SBOM.

The index provides O(1) lookups for dependencies, dependents, and name-based searches. Build once and reuse for multiple operations.

§Example
let sbom = parse_sbom(&path)?;
let index = sbom.build_index();

// Fast dependency lookup
let deps = index.dependencies_of(&component_id, &sbom.edges);
Source

pub fn get_dependencies_indexed<'a>( &'a self, id: &CanonicalId, index: &NormalizedSbomIndex, ) -> Vec<&'a DependencyEdge>

Get dependencies using an index (O(k) instead of O(edges)).

Use this when you have a prebuilt index for repeated lookups.

Source

pub fn get_dependents_indexed<'a>( &'a self, id: &CanonicalId, index: &NormalizedSbomIndex, ) -> Vec<&'a DependencyEdge>

Get dependents using an index (O(k) instead of O(edges)).

Use this when you have a prebuilt index for repeated lookups.

Source

pub fn find_by_name_indexed( &self, name: &str, index: &NormalizedSbomIndex, ) -> Vec<&Component>

Find components by name (case-insensitive) using an index.

Returns components whose lowercased name exactly matches the query.

Source

pub fn search_by_name_indexed( &self, query: &str, index: &NormalizedSbomIndex, ) -> Vec<&Component>

Search components by name (case-insensitive substring) using an index.

Returns components whose name contains the query substring.

Source

pub fn apply_cra_sidecar(&mut self, sidecar: &CraSidecarMetadata)

Apply CRA sidecar metadata to supplement SBOM fields.

Sidecar values only override SBOM fields if the SBOM field is None/empty. This ensures SBOM data takes precedence when available.

Trait Implementations§

Source§

impl Clone for NormalizedSbom

Source§

fn clone(&self) -> NormalizedSbom

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 NormalizedSbom

Source§

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

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

impl Default for NormalizedSbom

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for NormalizedSbom

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 Serialize for NormalizedSbom

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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