Struct Component 

pub struct Component {
    pub name: String,
    pub version: Option<String>,
    pub component_type: ComponentType,
    pub purl: Option<String>,
    pub description: Option<String>,
    pub author: Option<String>,
    pub license: Option<String>,
    pub repository: Option<String>,
    pub hash_sha256: Option<String>,
}

A component in the SBOM.

Fields

name: String

Component name

version: Option<String>

Component version

component_type: ComponentType

Component type

purl: Option<String>

Package URL (purl)

description: Option<String>

Description

author: Option<String>

Author or publisher

license: Option<String>

License identifier

repository: Option<String>

Repository URL

hash_sha256: Option<String>

SHA-256 hash of the component

Implementations

impl Component

pub fn new(name: impl Into<String>, component_type: ComponentType) -> Self

Create a new component.

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

Set the version.

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

Set the purl.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description.

pub fn with_author(self, author: impl Into<String>) -> Self

Set the author.

pub fn with_license(self, license: impl Into<String>) -> Self

Set the license.

pub fn with_repository(self, repo: impl Into<String>) -> Self

Set the repository URL.

pub fn with_hash(self, hash: impl Into<String>) -> Self

Set the SHA-256 hash.

pub fn npm_purl(name: &str, version: Option<&str>) -> String

Generate a purl for npm packages.

pub fn github_purl(owner: &str, repo: &str, version: Option<&str>) -> String

Generate a purl for GitHub repositories.

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