Struct License 

pub struct License {
    pub extensions: Extensions,
    /* private fields */
}

License information for the exposed API.

Every version of the specification makes identifier and url mutually exclusive, and makes both optional beside a required name. This type holds at most one of the two, so the three states the specification allows are the three a program can build — and a document setting both cannot be constructed, nor parsed, nor emitted.

Reach for spdx in preference to with_url: an SPDX expression is machine-readable and a URL is not. Both are permitted, which is why both are here.

Fields

extensions: Extensions

Specification extensions.

Implementations

impl License

pub fn named(name: impl Into<String>) -> Self

Creates a license identified by name alone.

Valid, and the weakest of the three: a consumer gets something to show a human and nothing to resolve.

pub fn spdx(name: impl Into<String>, identifier: impl Into<String>) -> Self

Creates a license identified by an SPDX expression.

This is preferred over License::with_url: an SPDX identifier is machine-readable, a URL is not.

pub fn with_url(name: impl Into<String>, url: impl Into<String>) -> Self

Creates a license identified by a URL.

pub fn name(&self) -> &str

The license name used for the API.

pub fn identifier(&self) -> Option<&str>

The SPDX license expression, when this license carries one.

pub fn url(&self) -> Option<&str>

The URI for the license, when this license carries one.

Trait Implementations

impl Clone for License

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for License

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for License

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for License

impl PartialEq for License

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for License

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for License