Struct Version

pub struct Version {
    pub epoch: Option<u32>,
    pub chunks: Chunks,
    pub release: Option<Release>,
    pub meta: Option<String>,
}

A version number with decent structure and comparison logic.

This is a descriptive scheme, meaning that it encapsulates the most common, unconscious patterns that developers use when assigning version numbers to their software. If not crate::SemVer, most version numbers found in the wild will parse as a Version. These generally conform to the x.x.x-x pattern, and may optionally have an epoch.

Epochs

Epochs are prefixes marked by a colon, like in 1:2.3.4. When comparing two Version values, epochs take precedent. So 2:1.0.0 > 1:9.9.9. If one of the given Versions has no epoch, its epoch is assumed to be 0.

Examples

use versions::{SemVer, Version};

// None of these are SemVer, but can still be parsed and compared.
let vers = vec!["0.25-2", "8.u51-1", "20150826-1", "1:2.3.4"];

for v in vers {
    assert!(SemVer::new(v).is_none());
    assert!(Version::new(v).is_some());
}

Fields

epoch: Option<u32>

An optional prefix that marks that some paradigm shift in versioning has occurred between releases of some software.

chunks: Chunks

The main sections of the Version. Unlike crate::SemVer, these sections are allowed to contain letters.

release: Option<Release>

This either indicates a prerelease like crate::SemVer, or a “release” revision for software packages. In the latter case, a version like 1.2.3-2 implies that the software itself hasn’t changed, but that this is the second bundling/release (etc.) of that particular package.

meta: Option<String>

Some extra metadata that doesn’t factor into comparison.

Implementations

impl Version

pub fn new<S>(s: S) -> Option<Version>

where S: AsRef<str>,

Parse a Version from some input.

pub fn nth(&self, n: usize) -> Option<u32>

Try to extract a position from the Version as a nice integer, as if it were a crate::SemVer.

use versions::Version;

let mess = Version::new("1:2.a.4.5.6.7-r1").unwrap();
assert_eq!(Some(2), mess.nth(0));
assert_eq!(None, mess.nth(1));
assert_eq!(Some(4), mess.nth(2));

pub fn nth_lenient(&self, n: usize) -> Option<u32>

Like nth, but pulls a number even if it was followed by letters.

pub fn to_mess(&self) -> Mess

A lossless conversion from Version to Mess.

use versions::Version;

let orig = "1:1.2.3-r1";
let mess = Version::new(orig).unwrap().to_mess();

assert_eq!(orig, format!("{}", mess));

pub fn parse(i: &str) -> IResult<&str, Version>

The raw nom parser for Version. Feel free to use this in combination with other general nom parsers.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a duplicate 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 Default for Version

fn default() -> Version

Returns the “default value” for a type.

impl Display for Version

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

Formats the value using the given formatter.

impl FromStr for Version

type Err = Error

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 Version

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 Version

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

If two epochs are equal, we need to compare their actual version numbers. Otherwise, the comparison of the epochs is the only thing that matters.

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 Version

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

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<&str> for Version

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

use versions::Version;

let orig = "1.2.3.4";
let prsd: Version = orig.try_into().unwrap();
assert_eq!(orig, prsd.to_string());

type Error = Error

The type returned in the event of a conversion error.

impl Eq for Version

impl StructuralPartialEq for Version