Struct SpdxExpression

pub struct SpdxExpression { /* private fields */ }

Main struct for SPDX License Expressions.

Implementations

impl SpdxExpression

pub fn parse(expression: &str) -> Result<SpdxExpression, 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 identifiers(&self) -> HashSet<String>

Get all license and exception identifiers from the SpdxExpression.

Examples

let expression = SpdxExpression::parse("MIT OR Apache-2.0")?;
let licenses = expression.identifiers();
assert_eq!(licenses, HashSet::from_iter(["Apache-2.0".to_string(), "MIT".to_string()]));

let expression = SpdxExpression::parse("MIT OR GPL-2.0-only WITH Classpath-exception-2.0")?;
let licenses = expression.identifiers();
assert_eq!(
    licenses,
    HashSet::from_iter([
        "MIT".to_string(),
        "GPL-2.0-only".to_string(),
        "Classpath-exception-2.0".to_string()
    ])
);

pub fn licenses(&self) -> HashSet<&SimpleExpression>

Get all simple license expressions in Self. For licenses with exceptions, returns the license without the exception

Examples

let expression = SpdxExpression::parse(
    "(MIT OR Apache-2.0 AND (GPL-2.0-only WITH Classpath-exception-2.0 OR ISC))",
)
.unwrap();

let licenses = expression.licenses();

assert_eq!(
    licenses
        .iter()
        .map(|&license| license.identifier.as_str())
        .collect::<HashSet<_>>(),
    HashSet::from_iter(["Apache-2.0", "GPL-2.0-only", "ISC", "MIT"])
);

pub fn exceptions(&self) -> HashSet<&str>

Get all exception identifiers for Self.

Examples

let expression = SpdxExpression::parse(
    "(MIT OR Apache-2.0 AND (GPL-2.0-only WITH Classpath-exception-2.0 OR ISC))",
)
.unwrap();

let exceptions = expression.exceptions();

assert_eq!(exceptions, HashSet::from_iter(["Classpath-exception-2.0"]));

Trait Implementations

impl Clone for SpdxExpression

fn clone(&self) -> SpdxExpression

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for SpdxExpression

fn default() -> SpdxExpression

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpdxExpression

fn deserialize<D>( deserializer: D, ) -> Result<SpdxExpression, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SpdxExpression

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

Formats the value using the given formatter.

impl PartialEq for SpdxExpression

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpdxExpression

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpdxExpression

impl StructuralPartialEq for SpdxExpression