Struct spdx::expression::Expression

pub struct Expression { /* fields omitted */ }

An SPDX license expression that is both syntactically and semantically valid, and can be evaluated

Methods

impl Expression

pub fn requirements(&self) -> impl Iterator<Item = &ExpressionReq>

Returns each of the license requirements in the license expression, but not the operators that join them together

pub fn evaluate<AF: FnMut(&LicenseReq) -> bool>(&self, allow_func: AF) -> bool

Evaluates the expression, using the provided function to determine if the licensee meets the requirements for each license term. If enough requirements are satisfied the evaluation will return true.

pub fn evaluate_with_failures<AF: FnMut(&LicenseReq) -> bool>(
    &self,
    allow_func: AF
) -> Result<(), Vec<&ExpressionReq>>

Just as with evaluate, the license expression is evaluated to see if enough license requirements in the expresssion are met for the evaluation to succeed, except this method also keeps track of each failed requirement and returns them, allowing for more detailed error reporting about precisely what terms in the expression caused the overall failure

impl Expression

pub fn parse(original: &str) -> Result<Self, ParseError>

Given a license expression, attempts to parse and validate it as a valid SPDX expression

The validation can fail for many reasons:

• The expression contains invalid characters
• An unknown/invalid license or exception identifier was found. Only SPDX short identifiers are allowed
• The expression contained unbalanced parentheses
• A license or exception immediately follows another license or exception, without a valid AND, OR, or WITH operator separating them
• An AND, OR, or WITH doesn't have a license or ) preceding it

Trait Implementations

impl AsRef<str> for Expression

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Expression

fn clone(&self) -> Expression

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Expression> for Expression

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

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

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

This method tests for !=.

impl Display for Expression

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

Formats the value using the given formatter.

impl Debug for Expression

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

Formats the value using the given formatter.