Struct CanonicalId 

pub struct CanonicalId { /* private fields */ }

Canonical identifier for a component.

This provides a stable, comparable identifier across different SBOM formats. The identifier is derived from the PURL when available, falling back through a tiered strategy to ensure stability.

Implementations

impl CanonicalId

pub fn from_purl(purl: &str) -> Self

Create a new canonical ID from a PURL

pub fn from_name_version(name: &str, version: Option<&str>) -> Self

Create a new canonical ID from name and version

pub fn synthetic(group: Option<&str>, name: &str, version: Option<&str>) -> Self

Create a synthetic canonical ID from group, name, and version

This provides a stable identifier when primary identifiers (PURL, CPE, SWID) are not available. The format is: group:name@version or name@version.

pub fn from_format_id(id: &str) -> Self

Create a new canonical ID from a format-specific identifier

Warning: Format-specific IDs (like bom-ref UUIDs) are often unstable across SBOM regenerations. Use synthetic() or other methods when possible.

pub fn from_cpe(cpe: &str) -> Self

Create from CPE

pub fn from_swid(swid: &str) -> Self

Create from SWID tag

pub fn from_swhid(swhid: &str) -> Self

Create from a Software Heritage persistent identifier (SWHID).

SWHIDs are content-addressed identifiers of the form swh:1:<kind>:<sha1-hex>[;<qualifier>=<value>...]. Named explicitly by CRA prEN 40000-1-3 [PRE-7-RQ-07] alongside PURL/CPE.

Falls back to a FormatSpecific identifier (marked unstable) if the input does not look like a valid SWHID.

pub fn from_swhid_object(obj: &SwhidObject) -> Self

Create from a structured SwhidObject (preferred internal path).

pub fn value(&self) -> &str

Get the canonical ID value

pub const fn source(&self) -> &IdSource

Get the source of this identifier

pub const fn is_stable(&self) -> bool

Returns true if this identifier is stable across SBOM regenerations

Trait Implementations

impl Clone for CanonicalId

fn clone(&self) -> CanonicalId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanonicalId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CanonicalId

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

Formats the value using the given formatter.

impl Eq for CanonicalId

impl Hash for CanonicalId

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CanonicalId

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CanonicalId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.