Struct spdx_rs::models::SPDX

pub struct SPDX {
    pub document_creation_information: DocumentCreationInformation,
    pub package_information: Vec<PackageInformation>,
    pub other_licensing_information_detected: Vec<OtherLicensingInformationDetected>,
    pub file_information: Vec<FileInformation>,
    pub snippet_information: Vec<Snippet>,
    pub relationships: Vec<Relationship>,
    pub annotations: Vec<Annotation>,
    pub spdx_ref_counter: i32,
}

A representation of an SPDX Document

This is the main struct of this crate. The struct implements Serialize and Deserialize to allow it to be serialized into and deserialized from any data format supported by Serde.

SPDX specification version

The crate has been developed around SPDX version 2.2.1. Fields deprecated in 2.2.1, like review information are not supported. The plan is to support newer versions as they are released.

Data formats

The crate has been developed for usage with JSON SPDX documents. The naming of the fields should conform to the spec for at least JSON. Other formats, like YAML may work, but no guarantees are made.

The crate also allows for deserializing the struct from SPDX documents in tag-value format with crate::parsers::spdx_from_tag_value.

Fields

document_creation_information: DocumentCreationInformation

https://spdx.github.io/spdx-spec/2-document-creation-information/

package_information: Vec<PackageInformation>

https://spdx.github.io/spdx-spec/3-package-information/

other_licensing_information_detected: Vec<OtherLicensingInformationDetected>

https://spdx.github.io/spdx-spec/6-other-licensing-information-detected/

file_information: Vec<FileInformation>

https://spdx.github.io/spdx-spec/4-file-information/

snippet_information: Vec<Snippet>

https://spdx.github.io/spdx-spec/5-snippet-information/

relationships: Vec<Relationship>

https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/

annotations: Vec<Annotation>

https://spdx.github.io/spdx-spec/8-annotations/

spdx_ref_counter: i32

Counter for creating SPDXRefs. Is not part of the spec, so don’t serialize.

Implementations

impl SPDX

pub fn new(name: &str) -> Self

Create new SPDX struct.

pub fn get_unique_hashes(&self, algorithm: Algorithm) -> HashSet<String>

Get unique hashes for all files the SPDX.

pub fn get_files_for_package(
    &self,
    package_spdx_id: &str
) -> Vec<(&FileInformation, &Relationship)>

Find related files of the package with the provided id.

pub fn get_license_ids(&self) -> HashSet<String>

Get all license identifiers from the SPDX.

Errors

Returns [SpdxError] if parsing of the expressions fails.

pub fn relationships_for_spdx_id(&self, spdx_id: &str) -> Vec<&Relationship>

Get all relationships where the given SPDX ID is the SPDX element id.

pub fn relationships_for_related_spdx_id(
    &self,
    spdx_id: &str
) -> Vec<&Relationship>

Get all relationships where the given SPDX ID is the related SPDX element id.

Trait Implementations

impl Debug for SPDX

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SPDX

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SPDX> for SPDX

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for SPDX

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 SPDX