Struct Component 

pub struct Component {

    pub canonical_id: CanonicalId,
    pub identifiers: ComponentIdentifiers,
    pub name: String,
    pub version: Option<String>,
    pub semver: Option<Version>,
    pub component_type: ComponentType,
    pub ecosystem: Option<Ecosystem>,
    pub licenses: LicenseInfo,
    pub supplier: Option<Organization>,
    pub hashes: Vec<Hash>,
    pub external_refs: Vec<ExternalReference>,
    pub vulnerabilities: Vec<VulnerabilityRef>,
    pub vex_status: Option<VexStatus>,
    pub content_hash: u64,
    pub extensions: ComponentExtensions,
    pub description: Option<String>,
    pub copyright: Option<String>,
    pub author: Option<String>,
    pub group: Option<String>,
    pub is_external: bool,
    pub version_range: Option<String>,
    pub staleness: Option<StalenessInfo>,
    pub eol: Option<EolInfo>,
    pub crypto_properties: Option<CryptoProperties>,
}

Component in the normalized SBOM

Fields

canonical_id: CanonicalId

Canonical identifier

identifiers: ComponentIdentifiers

Various identifiers (PURL, CPE, etc.)

name: String

Component name

version: Option<String>

Version string

semver: Option<Version>

Parsed semantic version (if valid)

component_type: ComponentType

Component type

ecosystem: Option<Ecosystem>

Package ecosystem

licenses: LicenseInfo

License information

supplier: Option<Organization>

Supplier/vendor information

hashes: Vec<Hash>

Cryptographic hashes

external_refs: Vec<ExternalReference>

External references

vulnerabilities: Vec<VulnerabilityRef>

Known vulnerabilities

vex_status: Option<VexStatus>

VEX status

content_hash: u64

Content hash for quick comparison

extensions: ComponentExtensions

Format-specific extensions

description: Option<String>

Description

copyright: Option<String>

Copyright text

author: Option<String>

Author information

group: Option<String>

Group/namespace (e.g., Maven groupId)

is_external: bool

Whether this component is external (expected from environment, not bundled)

version_range: Option<String>

Package URL Version Range (vers) syntax, only valid when is_external is true

staleness: Option<StalenessInfo>

Staleness information (populated by enrichment)

eol: Option<EolInfo>

End-of-life information (populated by enrichment)

crypto_properties: Option<CryptoProperties>

Cryptographic properties (CycloneDX 1.6+ cryptoProperties)

Implementations

impl Component

pub fn new(name: String, format_id: String) -> Self

Create a new component with minimal required fields

pub fn with_purl(self, purl: String) -> Self

Set the PURL and update canonical ID

pub fn with_version(self, version: String) -> Self

Set the version and try to parse as semver

pub fn with_swhid(self, swhid: String) -> Self

Add a Software Heritage persistent identifier (SWHID) from a string.

Invalid SWHIDs are silently dropped (matches the parser-tolerant behaviour of CanonicalId::from_swhid). Use with_swhid_object when you already have a SwhidObject in hand.

Recognised by CRA prEN 40000-1-3 [PRE-7-RQ-07] as one of the three named identifier types (alongside PURL and CPE). Multiple SWHIDs can be attached to a single component (e.g., a dir SWHID for the unpacked tree plus cnt SWHIDs for individual files).

pub fn with_swhid_object(self, swhid: SwhidObject) -> Self

Add a structured SwhidObject SWHID.

pub fn calculate_content_hash(&mut self)

Calculate and update content hash

pub fn is_oss(&self) -> bool

Check if this is an OSS (open source) component

pub fn display_name(&self) -> String

Get display name with version

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Component> for ComponentRef

fn from(component: &Component) -> Self

Converts to this type from the input type.

impl Serialize for Component

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

where __S: Serializer,

Serialize this value into the given Serde serializer.