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 the requirement placed by a license holder

let licensee = spdx::Licensee::parse("GPL-2.0").unwrap();

assert!(licensee.satisfies(&spdx::LicenseReq::from(spdx::license_id("GPL-2.0-only").unwrap())));

Implementations

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 ignored for licensees as it only applies to the license holder(s) not the licensee

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.

use spdx::Licensee;

// Normal single license
Licensee::parse("MIT").unwrap();

// SPDX allows license identifiers outside of the official license list
// via the LicenseRef- prefix
Licensee::parse("LicenseRef-My-Super-Extra-Special-License").unwrap();

// License and exception
Licensee::parse("Apache-2.0 WITH LLVM-exception").unwrap();

// `+` is only allowed to be used by license requirements from the license holder
Licensee::parse("Apache-2.0+").unwrap_err();

Licensee::parse("GPL-2.0").unwrap();

// GNU suffix license (GPL, AGPL, LGPL, GFDL) must not contain the suffix
Licensee::parse("GPL-3.0-or-later").unwrap_err();

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

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

let licensee = spdx::Licensee::parse("Apache-2.0 WITH LLVM-exception").unwrap();

assert!(licensee.satisfies(&spdx::LicenseReq {
    license: spdx::LicenseItem::Spdx {
        id: spdx::license_id("Apache-2.0").unwrap(),
        // Means the license holder is fine with Apache-2.0 or higher
        or_later: true,
    },
    exception: spdx::exception_id("LLVM-exception"),
}));

Trait Implementations

impl Debug for Licensee

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

Formats the value using the given formatter.

impl Display for Licensee

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

Formats the value using the given formatter.

impl Eq for Licensee

impl Ord for Licensee

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

This method tests for !=.

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 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]pub fn lt(&self, other: &Rhs) -> bool

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

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

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

#[must_use]pub 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 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.

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

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

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

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

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

impl StructuralPartialEq for Licensee