Struct serde_cyclonedx::cyclonedx::v_1_4::CycloneDxBuilder

pub struct CycloneDxBuilder { /* private fields */ }

Builder for CycloneDx.

Implementations

impl CycloneDxBuilder

pub fn schema<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

pub fn bom_format<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces. This value MUST be “CycloneDX”.

pub fn components<VALUE: Into<Vec<Component>>>( &mut self, value: VALUE ) -> &mut Self

A list of software and hardware components.

pub fn compositions<VALUE: Into<Vec<Compositions>>>( &mut self, value: VALUE ) -> &mut Self

Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness.

pub fn dependencies<VALUE: Into<Vec<Dependency>>>( &mut self, value: VALUE ) -> &mut Self

Provides the ability to document dependency relationships.

pub fn external_references<VALUE: Into<Vec<ExternalReference>>>( &mut self, value: VALUE ) -> &mut Self

External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM.

pub fn metadata<VALUE: Into<Metadata>>(&mut self, value: VALUE) -> &mut Self

Provides additional information about a BOM.

pub fn serial_number<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.

pub fn services<VALUE: Into<Vec<Service>>>(&mut self, value: VALUE) -> &mut Self

A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.

pub fn signature<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Enveloped signature in JSON Signature Format (JSF).

pub fn spec_version<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).

pub fn version<VALUE: Into<i64>>(&mut self, value: VALUE) -> &mut Self

Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is ‘1’.

pub fn vulnerabilities<VALUE: Into<Vec<Vulnerability>>>( &mut self, value: VALUE ) -> &mut Self

Vulnerabilities identified in components or services.

pub fn build(&self) -> Result<CycloneDx, CycloneDxBuilderError>

Builds a new CycloneDx.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CycloneDxBuilder

fn clone(&self) -> CycloneDxBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CycloneDxBuilder

fn default() -> Self

Returns the “default value” for a type.