Struct python_packaging::licensing::LicensedComponent

pub struct LicensedComponent { /* private fields */ }

Represents a software component with licensing information.

Implementations

impl LicensedComponent

pub fn new(flavor: ComponentFlavor, license: LicenseFlavor) -> Self

Construct a new instance from parameters.

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

Construct a new instance from an SPDX expression.

pub fn flavor(&self) -> &ComponentFlavor

The type 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 homepage(&self) -> Option<&str>

Obtain the homepage / URL of this component.

pub fn set_homepage(&mut self, value: impl ToString)

Set the homepage of this component.

pub fn authors(&self) -> &[String]

Obtain the annotated authors of this component.

pub fn add_author(&mut self, value: impl ToString)

Define an author of this component.

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.

pub fn all_spdx_license_names(&self, full: bool) -> Vec<String>

Obtain all SPDX license names.

pub fn all_spdx_license_ids(&self) -> BTreeSet<LicenseId>

Obtain all the distinct LicenseId in this component.

Unlike Self::all_spdx_licenses(), this returns just the license IDs without exceptions.

pub fn all_spdx_exception_ids(&self) -> BTreeSet<ExceptionId>

Obtain all the ExceptionId present in this component.

pub fn has_copyleft(&self) -> bool

Whether the component has any copyleft licenses.

pub fn is_always_copyleft(&self) -> bool

Whether all licenses are copyleft.

pub fn licensing_summary(&self) -> String

Obtain a textual licensing summary of this component.

Trait Implementations

impl Clone for LicensedComponent

fn clone(&self) -> LicensedComponent

Returns a copy of the value.

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 Ord for LicensedComponent

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<LicensedComponent> for LicensedComponent

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

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

fn ne(&self, other: &Rhs) -> 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.

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

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

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

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

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

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

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 TryInto<LicensedComponent> for PackageLicenseInfo

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<LicensedComponent, Self::Error>

Performs the conversion.

impl Eq for LicensedComponent