Struct spdx_expression::SPDXExpression

pub struct SPDXExpression { /* private fields */ }

Main struct for SPDX License Expressions.

Implementations

impl SPDXExpression

pub fn parse(expression: &str) -> Result<Self, SpdxExpressionError>

Parse Self from a string. The input expression needs to be a syntactically valid SPDX expression, NONE or NOASSERTION. The parser accepts license identifiers that are not valid SPDX.

Examples

let expression = SPDXExpression::parse("MIT")?;

License expressions need to be syntactically valid, but they can include license identifiers not on the SPDX license list or not specified with LicenseRef.

let expression = SPDXExpression::parse("MIT OR InvalidLicenseId")?;

Errors

Returns SpdxExpressionError if the license expression is not syntactically valid.

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

Get all license and exception identifiers from the SPDXExpression. Returns the licenses alphabetically sorted and deduped.

Examples

let expression = SPDXExpression::parse("MIT OR Apache-2.0")?;
let licenses = expression.licenses();
assert_eq!(licenses, vec!["Apache-2.0".to_string(), "MIT".to_string()]);

Trait Implementations

impl Clone for SPDXExpression

fn clone(&self) -> SPDXExpression

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SPDXExpression

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

Formats the value using the given formatter.

impl Display for SPDXExpression

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

Formats the value using the given formatter.

impl PartialEq<SPDXExpression> for SPDXExpression

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

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

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

This method tests for !=.

impl Eq for SPDXExpression

impl StructuralEq for SPDXExpression

impl StructuralPartialEq for SPDXExpression