Struct pep440_rs::Version

pub struct Version { /* private fields */ }

A version number such as 1.2.3 or 4!5.6.7-a8.post9.dev0.

Beware that the sorting implemented with Ord and Eq is not consistent with the operators from PEP 440, i.e. compare two versions in rust with > gives a different result than a VersionSpecifier with > as operator.

Parse with Version::from_str:

use std::str::FromStr;
use pep440_rs::Version;

let version = Version::from_str("1.19").unwrap();

Implementations

impl Version

pub fn new<I, R>(release_numbers: I) -> Version

where I: IntoIterator<Item = R>, R: Borrow<u64>,

Create a new version from an iterator of segments in the release part of a version.

Panics

When the iterator yields no elements.

pub fn any_prerelease(&self) -> bool

Whether this is an alpha/beta/rc or dev version

pub fn is_pre(&self) -> bool

Whether this is an alpha/beta/rc version

pub fn is_dev(&self) -> bool

Whether this is a dev version

pub fn is_post(&self) -> bool

Whether this is a post version

pub fn is_local(&self) -> bool

Whether this is a local version (e.g. 1.2.3+localsuffixesareweird)

When true, it is guaranteed that the slice returned by Version::local is non-empty.

pub fn epoch(&self) -> u64

Returns the epoch of this version.

pub fn release(&self) -> &[u64]

Returns the release number part of the version.

pub fn pre(&self) -> Option<PreRelease>

Returns the pre-release part of this version, if it exists.

pub fn post(&self) -> Option<u64>

Returns the post-release part of this version, if it exists.

pub fn dev(&self) -> Option<u64>

Returns the dev-release part of this version, if it exists.

pub fn local(&self) -> &[LocalSegment]

Returns the local segments in this version, if any exist.

pub fn with_release<I, R>(self, release_numbers: I) -> Version

where I: IntoIterator<Item = R>, R: Borrow<u64>,

Set the release numbers and return the updated version.

Usually one can just use Version::new to create a new version with the updated release numbers, but this is useful when one wants to preserve the other components of a version number while only changing the release numbers.

Panics

When the iterator yields no elements.

pub fn with_epoch(self, value: u64) -> Version

Set the epoch and return the updated version.

pub fn with_pre(self, value: Option<PreRelease>) -> Version

Set the pre-release component and return the updated version.

pub fn with_post(self, value: Option<u64>) -> Version

Set the post-release component and return the updated version.

pub fn with_dev(self, value: Option<u64>) -> Version

Set the dev-release component and return the updated version.

pub fn with_local(self, value: Vec<LocalSegment>) -> Version

Set the local segments and return the updated version.

pub fn without_local(self) -> Version

For PEP 440 specifier matching: “Except where specifically noted below, local version identifiers MUST NOT be permitted in version specifiers, and local version labels MUST be ignored entirely when checking if candidate versions match a given version specifier.”

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl Display for Version

Shows normalized version

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

Formats the value using the given formatter.

impl FromStr for Version

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

Parses a version such as 1.19, 1.0a1,1.0+abc.5 or 1!2012.2

Note that this doesn’t allow wildcard versions.

type Err = VersionParseError

The associated error which can be returned from parsing.

impl Hash for Version

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

Custom implementation to ignoring trailing zero because PartialEq zero pads

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 Version

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

1.0.dev456 < 1.0a1 < 1.0a2.dev456 < 1.0a12.dev456 < 1.0a12 < 1.0b1.dev456 < 1.0b2 < 1.0b2.post345.dev456 < 1.0b2.post345 < 1.0b2-346 < 1.0c1.dev456 < 1.0c1 < 1.0rc2 < 1.0c3 < 1.0 < 1.0.post456.dev34 < 1.0.post456

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Version

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Version

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

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

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

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

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

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

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 Eq for Version