Struct License 

pub struct License(/* private fields */);

A license governing the use and or distribution for a product.

Where available, SPDX short identifiers are preferred.

Implementations

impl License

pub const MIN_CHAR_LENGTH: usize = 3usize

pub const MAX_CHAR_LENGTH: usize = 512usize

pub const PROPRIETARY: Self

Represents a proprietary license.

Use this when the license information for a package is unknown or not publicly available. Proprietary licenses typically restrict usage, modification, and redistribution.

pub const APACHE_V1: Self

https://spdx.org/licenses/Apache-1.0.html

pub const APACHE_V1_1: Self

https://spdx.org/licenses/Apache-1.1.html

pub const APACHE_V2: Self

https://spdx.org/licenses/Apache-2.0.html

pub const BSD_V3_CLAUSE_NEW_OR_REVISED: Self

https://spdx.org/licenses/BSD-3-Clause.html

pub const AGPL_V1_ONLY: Self

https://spdx.org/licenses/AGPL-1.0-only.html

pub const AGPL_V1_OR_LATER: Self

https://spdx.org/licenses/AGPL-1.0-or-later.html

pub const AGPL_V3_ONLY: Self

https://spdx.org/licenses/AGPL-3.0-only.html

pub const AGPL_V3_OR_LATER: Self

https://spdx.org/licenses/AGPL-3.0-or-later.html

pub const GPL_V1_ONLY: Self

https://spdx.org/licenses/GPL-1.0-only.html

pub const GPL_V1_OR_LATER: Self

https://spdx.org/licenses/GPL-1.0-or-later.html

pub const GPL_V2_ONLY: Self

https://spdx.org/licenses/GPL-2.0-only.html

pub const GPL_V2_OR_LATER: Self

https://spdx.org/licenses/GPL-2.0-or-later.html

pub const GPL_V3_ONLY: Self

https://spdx.org/licenses/GPL-3.0-only.html

pub const GPL_V3_OR_LATER: Self

https://spdx.org/licenses/GPL-3.0-or-later.html

pub const MIT: Self

https://spdx.org/licenses/MIT.html

pub fn new<T: AsRef<str> + Into<CompactString>>( license: T, ) -> Result<Self, LicenseError>

Creates a new License from any type that implements AsRef<str> and Into<CompactString>.

Errors

Returns an Err if the license is less than 3 characters long or more than 512 characters long.

Examples

use winget_types::locale::License;

let license = License::new("MIT")?;

assert_eq!(license.as_str(), "MIT");

pub unsafe fn new_unchecked<T: Into<CompactString>>(license: T) -> Self

Creates a new License from any type that implements Into<CompactString> without checking its validity.

Safety

The license must not be less than 3 characters long or more than 512 characters long.

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire License.

Trait Implementations

impl AsRef<str> for License

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for License

fn clone(&self) -> License

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 Default for License

fn default() -> Self

Returns the “default value” for a type.

impl Display for License

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

Formats the value using the given formatter.

impl FromStr for License

type Err = LicenseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for License

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for License

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for License

fn eq(&self, other: &License) -> 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 PartialOrd for License

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<CompactString> for License

type Error = LicenseError

The type returned in the event of a conversion error.

fn try_from(value: CompactString) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for License

impl StructuralPartialEq for License