Struct Package 

#[non_exhaustive]
pub struct Package {

    pub architecture: Option<String>,
    pub cpe_name: Option<String>,
    pub epoch: Option<i64>,
    pub hash: Option<Box<Fingerprint>>,
    pub license: Option<String>,
    pub license_url: Option<String>,
    pub name: Option<String>,
    pub package_manager: Option<String>,
    pub package_manager_url: Option<String>,
    pub purl: Option<String>,
    pub release: Option<String>,
    pub src_url: Option<String>,
    pub type: Option<String>,
    pub type_id: Option<i64>,
    pub uid: Option<String>,
    pub vendor_name: Option<String>,
    pub version: Option<String>,
}

Software Package

The Software Package object describes details about a software package.

[] Category: | Name: package

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

architecture: Option<String>

Architecture

Architecture is a shorthand name describing the type of computer hardware the packaged software is meant to run on.

recommended

cpe_name: Option<String>

The product CPE identifier

The Common Platform Enumeration (CPE) name as described by (NIST) For example: cpe:/a:apple:safari:16.2.

optional

epoch: Option<i64>

Epoch

The software package epoch. Epoch is a way to define weighted dependencies based on version numbers.

optional

hash: Option<Box<Fingerprint>>

Hash

Cryptographic hash to identify the binary instance of a software component. This can include any component such file, package, or library.

optional

license: Option<String>

Software License

The software license applied to this package.

optional

license_url: Option<String>

Software License URL

The URL pointing to the license applied on package or software. This is typically a LICENSE.md file within a repository.

optional

name: Option<String>

Name

The software package name.

required

package_manager: Option<String>

Package Manager

The software packager manager utilized to manage a package on a system, e.g. npm, yum, dpkg etc.

optional

package_manager_url: Option<String>

Package Manager URL

The URL of the package or library at the package manager, or the specific URL or URI of an internal package manager link such as AWS CodeArtifact or Artifactory.

optional

purl: Option<String>

Package URL

A purl is a URL string used to identify and locate a software package in a mostly universal and uniform way across programming languages, package managers, packaging conventions, tools, APIs and databases.

optional

release: Option<String>

Software Release Details

Release is the number of times a version of the software has been packaged.

optional

src_url: Option<String>

Source URL

The link to the specific library or package such as within GitHub, this is different from the link to the package manager where the library or package is hosted.

optional

type: Option<String>

Type

The type of software package, normalized to the caption of the type_id value. In the case of ‘Other’, it is defined by the source.

optional

type_id: Option<i64>

Type ID

The type of software package.

recommended

uid: Option<String>

Package UID

A unique identifier for the package or library reported by the source tool. E.g., the libId within the sbom field of an OX Security Issue or the SPDX components.*.bom-ref.

optional

vendor_name: Option<String>

Vendor Name

The name of the vendor who published the software package.

optional

version: Option<String>

Version

The software package version.

required

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Package

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Package

where Package: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Package

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Package

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Package