Struct spdx::Licensee

pub struct Licensee { /* fields omitted */ }

A convenience wrapper for a license and optional exception that can be checked against a license requirement to see if it satisfies/matches the requirement

Methods

impl Licensee

pub fn new(license: LicenseItem, exception: Option<ExceptionId>) -> Self

Creates a licensee from its component parts. Note that use of SPDX's or_later is completely ignore for licensees as it only applies to the license holder

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

Parses an simplified version of an SPDX license expression that can contain at most 1 valid SDPX license with an optional exception joined by a WITH.

eg <license-id> | <license-id> WITH <exception-id>

pub fn satisfies(&self, req: &LicenseReq) -> bool

Determines whether the specified license requirement is satisfied by this license (+exception)

Trait Implementations

impl Eq for Licensee

impl PartialOrd<Licensee> for Licensee

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

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

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

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

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

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

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

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

fn ge(&self, other: &Licensee) -> bool

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

impl PartialOrd<LicenseReq> for Licensee

fn partial_cmp(&self, o: &LicenseReq) -> Option<Ordering>

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<Licensee> for Licensee

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

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

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

This method tests for !=.

impl PartialEq<LicenseReq> for Licensee

fn eq(&self, o: &LicenseReq) -> 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 Ord for Licensee

fn cmp(&self, other: &Licensee) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Debug for Licensee

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

Formats the value using the given formatter.