Skip to main content

Component

Struct Component 

Source
pub struct Component {
    pub id: ComponentId,
    pub name: String,
    pub version: Option<String>,
    pub ecosystem: Option<String>,
    pub supplier: Option<String>,
    pub description: Option<String>,
    pub purl: Option<String>,
    pub licenses: BTreeSet<String>,
    pub hashes: BTreeMap<String, String>,
    pub source_ids: Vec<String>,
}
Expand description

A software component (package, library, or application).

Represents a single entry in the SBOM with all its metadata. Components are identified by their ComponentId and can have relationships to other components via the dependency graph.

Fields§

§id: ComponentId

Stable identifier for this component.

§name: String

Package name (e.g., “serde”, “lodash”).

§version: Option<String>

Package version (e.g., “1.0.0”, “4.17.21”).

§ecosystem: Option<String>

Package ecosystem (e.g., “cargo”, “npm”, “pypi”).

§supplier: Option<String>

Package supplier or publisher.

§description: Option<String>

Human-readable description.

§purl: Option<String>

Package URL per the purl spec.

§licenses: BTreeSet<String>

SPDX license identifiers (e.g., “MIT”, “Apache-2.0”).

§hashes: BTreeMap<String, String>

Checksums keyed by algorithm (e.g., “sha256” -> “abc123…”).

§source_ids: Vec<String>

Original identifiers from the source document (e.g., SPDX SPDXRef, CycloneDX bom-ref).

Implementations§

Source§

impl Component

Source

pub fn new(name: String, version: Option<String>) -> Self

Creates a new component with the given name and optional version.

The component ID is generated from a hash of the name and version. Use this for simple cases; for full control, construct the struct directly.

Source§

impl Component

Source

pub fn normalize(&mut self)

Normalizes the component for deterministic comparison.

Lowercases hash keys and values. Licenses are stored as a BTreeSet so they’re already sorted and deduplicated.

Trait Implementations§

Source§

impl Clone for Component

Source§

fn clone(&self) -> Component

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 Component

Source§

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

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

impl<'de> Deserialize<'de> for Component

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 Component

Source§

fn eq(&self, other: &Component) -> 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 Component

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 Component

Source§

impl StructuralPartialEq for Component

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<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>,