Struct VersionSpecifier 

pub struct VersionSpecifier { /* private fields */ }

A version range such as >1.2.3, <=4!5.6.7-a8.post9.dev0 or == 4.1.*. Parse with VersionSpecifier::from_str.

use std::str::FromStr;
use uv_pep440::{Version, VersionSpecifier};

let version = Version::from_str("1.19").unwrap();
let version_specifier = VersionSpecifier::from_str("== 1.*").unwrap();
assert!(version_specifier.contains(&version));

PartialEq, Hash and Ord distinguish ~= specifiers by their release segment count, since ~=10.1.0 (>=10.1.0, <10.2) and ~=10.1 (>=10.1, <11) match different version sets per PEP 440. For other operators, trailing zeros are insignificant.

Implementations

impl VersionSpecifier

pub fn from_pattern( operator: Operator, version_pattern: VersionPattern, ) -> Result<Self, VersionSpecifierBuildError>

Build from parts, validating that the operator is allowed with that version. The last parameter indicates a trailing .*, to differentiate between 1.1.* and 1.1

pub fn from_version( operator: Operator, version: Version, ) -> Result<Self, VersionSpecifierBuildError>

Create a new version specifier from an operator and a version.

pub fn only_release(self) -> Self

Remove all non-release parts of the version.

The marker decision diagram relies on the assumption that the negation of a marker tree is the complement of the marker space. However, pre-release versions violate this assumption.

For example, the marker python_full_version > '3.9' or python_full_version <= '3.9' does not match python_full_version == 3.9.0a0 and so cannot simplify to true. However, its negation, python_full_version > '3.9' and python_full_version <= '3.9', also does not match 3.9.0a0 and simplifies to false, which violates the algebra decision diagrams rely on. For this reason we ignore pre-release versions entirely when evaluating markers.

Note that python_version cannot take on pre-release values as it is truncated to just the major and minor version segments. Thus using release-only specifiers is definitely necessary for python_version to fully simplify any ranges, such as python_version > '3.9' or python_version <= '3.9', which is always true for python_version. For python_full_version however, this decision is a semantic change.

For Python versions, the major.minor is considered the API version, so unlike the rules for package versions in PEP 440, we Python 3.9.0a0 is acceptable for >= "3.9".

pub fn only_minor_release(&self) -> Self

Remove all parts of the version beyond the minor segment of the release.

pub fn equals_version(version: Version) -> Self

==<version>

pub fn equals_star_version(version: Version) -> Self

==<version>.*

pub fn not_equals_star_version(version: Version) -> Self

!=<version>.*

pub fn not_equals_version(version: Version) -> Self

!=<version>

pub fn greater_than_equal_version(version: Version) -> Self

>=<version>

pub fn greater_than_version(version: Version) -> Self

><version>

pub fn less_than_equal_version(version: Version) -> Self

<=<version>

pub fn less_than_version(version: Version) -> Self

<<version>

pub fn operator(&self) -> &Operator

Get the operator, e.g. >= in >= 2.0.0

pub fn version(&self) -> &Version

Get the version, e.g. 2.0.0 in <= 2.0.0

pub fn into_parts(self) -> (Operator, Version)

Get the operator and version parts of this specifier.

pub fn any_prerelease(&self) -> bool

Whether the version marker includes a prerelease.

pub fn from_release_only_bounds( bounds: (&Bound<Version>, &Bound<Version>), ) -> impl Iterator<Item = Self>

Returns the version specifiers whose union represents the given range.

This function is not applicable to ranges involving pre-release versions.

pub fn from_lower_bound(bound: &Bound<Version>) -> Option<Self>

Returns a version specifier representing the given lower bound.

pub fn from_upper_bound(bound: &Bound<Version>) -> Option<Self>

Returns a version specifier representing the given upper bound.

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

Whether the given version satisfies the version range.

For example, >=1.19,<2.0 contains 1.21, but not 2.0.

See:

• https://peps.python.org/pep-0440/#version-specifiers
• https://github.com/pypa/packaging/blob/e184feef1a28a5c574ec41f5c263a3a573861f5a/packaging/specifiers.py#L362-L496

pub fn has_lower_bound(&self) -> bool

Whether this version specifier rejects versions below a lower cutoff.

Trait Implementations

impl Clone for VersionSpecifier

fn clone(&self) -> VersionSpecifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionSpecifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionSpecifier

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VersionSpecifier

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

Formats the value using the given formatter.

impl From<VersionSpecifier> for VersionSpecifiers

fn from(specifier: VersionSpecifier) -> Self

Converts to this type from the input type.

impl FromIterator<VersionSpecifier> for VersionSpecifiers

fn from_iter<T: IntoIterator<Item = VersionSpecifier>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for VersionSpecifier

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

Parses a version such as >= 1.19, == 1.1.*,~=1.0+abc.5 or <=1!2012.2

type Err = VersionSpecifierParseError

The associated error which can be returned from parsing.

impl Hash for VersionSpecifier

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 VersionSpecifier

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

fn eq(&self, other: &Self) -> 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 VersionSpecifier

fn partial_cmp(&self, other: &Self) -> 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 VersionSpecifier

https://github.com/serde-rs/serde/issues/1316#issue-332908452

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VersionSpecifier