Struct tugger_licensing::LicensedComponent

pub struct LicensedComponent { /* fields omitted */ }

Represents a software component with licensing information.

Implementations

impl LicensedComponent

pub fn new_spdx(name: &str, spdx_expression: &str) -> Result<Self>

Construct a new instance from an SPDX expression.

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

Construct a new instance with no licensing defined.

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

Construct a new instance with a license in the public domain.

pub fn new_unknown(name: &str, terms: Vec<String>) -> Self

Construct a new instance with an unknown license.

pub fn name(&self) -> &str

Obtain the name of this software component.

pub fn flavor(&self) -> &ComponentFlavor

The type of this component.

pub fn set_flavor(&mut self, flavor: ComponentFlavor)

Set the flavor of this component.

pub fn license(&self) -> &LicenseFlavor

Obtain the flavor of license for this component.

pub fn spdx_expression(&self) -> Option<&Expression>

Obtain the SPDX expression for this component’s license.

pub fn is_simple_spdx_expression(&self) -> bool

Whether the SPDX expression is simple.

Simple is defined as having at most a single license.

pub fn source_location(&self) -> &SourceLocation

Obtain the location where the source of this component can be obtained.

pub fn set_source_location(&mut self, location: SourceLocation)

Define where source code for this component can be obtained from.

pub fn license_texts(&self) -> &Vec<String>

Obtain the explicitly set license texts for this component.

pub fn add_license_text(&mut self, text: impl ToString)

Define the license text for this component.

pub fn is_spdx(&self) -> bool

Returns whether all license identifiers are SPDX.

pub fn all_spdx_licenses(&self) -> BTreeSet<(LicenseId, Option<ExceptionId>)>

Obtain all SPDX licenses referenced by this component.

The first element of the returned tuple is the license identifier. The 2nd is an optional exclusion identifier.

Trait Implementations

impl Clone for LicensedComponent

fn clone(&self) -> LicensedComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LicensedComponent

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

Formats the value using the given formatter.

impl PartialEq<LicensedComponent> for LicensedComponent

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

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

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

This method tests for !=.

impl PartialOrd<LicensedComponent> for LicensedComponent

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for LicensedComponent