Struct Requirement 

pub struct Requirement {
    pub kind: VersionKind,
    pub op: Op,
    pub scope: Option<CompactString>,
    pub major: Option<u32>,
    pub minor: Option<u32>,
    pub patch: Option<u32>,
    pub prerelease: Option<CompactString>,
}

A version requirement composed of a comparison operator and a full or partial version to match against. Build metadata is accepted when parsing, but is otherwise ignored.

Fields

kind: VersionKind

The kind of version.

op: Op

The comparison operator.

scope: Option<CompactString>

An optional scope prefix, for example the “vendor” in vendor-1.2.

major: Option<u32>

The major version number, or the year for calendar versions. A None is either an omitted part or a wildcard.

minor: Option<u32>

The minor version number, or the month for calendar versions. A None is either an omitted part or a wildcard.

patch: Option<u32>

The patch version number, or the day for calendar versions. A None is either an omitted part or a wildcard.

prerelease: Option<CompactString>

Optional pre-release identifier, for example the “alpha.1” in >=1.2.3-alpha.1.

Implementations

impl Requirement

pub fn parse<T>(value: T) -> Result<Requirement, SpecError>

where T: AsRef<str>,

Parses the provided value into a requirement.

pub fn matches_op(&self, version: &Version) -> bool

Returns true if the provided version satisfies the requirement’s operator, without checking pre-release compatibility. A scoped requirement only matches versions with the same scope, while an unscoped requirement matches any scope.

pub fn matches_exact(&self, version: &Version) -> bool

Returns true if the provided version exactly matches all defined parts of this requirement, including the pre-release. Omitted parts match any value.

pub fn matches_greater(&self, version: &Version) -> bool

Returns true if the provided version is greater (>) than this requirement. A partial requirement only matches versions beyond the defined parts, for example >1 does not match 1.5.0.

pub fn matches_less(&self, version: &Version) -> bool

Returns true if the provided version is less (<) than this requirement. A partial requirement only matches versions below the defined parts.

pub fn matches_tilde(&self, version: &Version) -> bool

Returns true for a patch-level (~) match: the defined major and minor parts must be equal, while the remaining parts may drift higher.

pub fn matches_caret(&self, version: &Version) -> bool

Returns true for a compatible (^) match: parts may drift up to the next major version, or the next minor or patch version when the major or minor is 0.

pub fn matches_pre(&self, version: &Version) -> bool

Returns true if this requirement has a pre-release on the same version numbers as the provided version, allowing a pre-release version to be matched.

Trait Implementations

impl Clone for Requirement

fn clone(&self) -> Requirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Requirement

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

Formats the value using the given formatter.

impl Default for Requirement

fn default() -> Requirement

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Requirement

fn deserialize<__D>( __deserializer: __D, ) -> Result<Requirement, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Requirement

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

Formats the value using the given formatter.

impl Eq for Requirement

impl FormatsVersion for Requirement

fn to_formatted_string(&self, options: &FormatOptions) -> String

Returns a formatted string representation of the version according to the provided options.

impl FromStr for Requirement

type Err = SpecError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Requirement, <Requirement as FromStr>::Err>

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

impl Hash for Requirement

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

where __H: Hasher,

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 MatchesVersion for Requirement

fn matches(&self, version: &Version) -> bool

Returns true if the provided version satisfies this shape, following the same rules as the [semver] crate.

impl Ord for Requirement

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Requirement

fn partial_cmp(&self, other: &Requirement) -> 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 Serialize for Requirement

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Requirement

impl TryFrom<String> for Requirement

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<Requirement, <Requirement as TryFrom<String>>::Error>

Performs the conversion.