Struct Version 

pub struct Version { /* private fields */ }

A semantic version, conformant to the semver spec.

Implementations

impl Version

pub fn major(&self) -> u64

Returns the major version.

pub fn minor(&self) -> u64

Returns the minor version.

pub fn patch(&self) -> u64

Returns the patch version.

pub fn new( major: u64, minor: u64, patch: u64, pre_release: Vec<Identifier>, build: Vec<Identifier>, ) -> Self

pub fn build(&self) -> &[Identifier]

pub fn pre_release(&self) -> &[Identifier]

pub fn into_parts(self) -> VersionParts

Consumes this version and returns owned components.

This moves build and prerelease identifiers out without cloning them.

use nodejs_semver::{Identifier, Version, VersionParts};

let version = Version::parse("1.2.3-alpha.1+build.7").unwrap();
let VersionParts {
    major,
    minor,
    patch,
    pre_release,
    build,
} = version.into_parts();

assert_eq!((major, minor, patch), (1, 2, 3));
assert_eq!(
    pre_release,
    vec![Identifier::AlphaNumeric("alpha".into()), Identifier::Numeric(1)]
);
assert_eq!(
    build,
    vec![
        Identifier::AlphaNumeric("build".into()),
        Identifier::Numeric(7)
    ]
);

pub fn satisfies(&self, range: &Range) -> bool

True if this Version satisfies the given Range.

pub fn satisfies_with_prerelease( &self, range: &Range, include_prerelease: bool, ) -> bool

True if this Version satisfies the given Range, treating prerelease versions as valid matches even when the range does not explicitly mention one.

pub fn is_prerelease(&self) -> bool

True is this Version has a prerelease component.

pub fn inc( &self, release: &str, identifier: Option<&str>, identifier_base: Option<IdentifierBase>, ) -> Result<Version, IncrementError>

Increment this Version according to the given release type, returning a new Version.

Mirrors the behavior of the SemVer.inc method in node-semver.

pub fn parse<S: AsRef<str>>(input: S) -> Result<Version, SemverError>

Parse a semver string into a Version.

use nodejs_semver::Version;

fn main() {
    let v = Version::parse("1.2.3-rc.4").unwrap();
    println!("{}", v);
}

pub fn diff(&self, other: &Self) -> Option<VersionDiff>

difference between two Versions by the release type, or None if the Versions are the same.

use nodejs_semver::{Version, VersionDiff};

fn main() {
    let v1 = Version::parse("1.2.3-rc.4").unwrap();
    let v2 = Version::parse("1.2.3").unwrap();

    let diff = v1.diff(&v2);

    assert_eq!(diff, Some(VersionDiff::Patch));
}

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

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

Formats the value using the given formatter.

impl Eq for Version

impl From<(i8, i8, i8)> for Version

fn from((major, minor, patch): (i8, i8, i8)) -> Self

Converts to this type from the input type.

impl From<(i8, i8, i8, i8)> for Version

fn from((major, minor, patch, pre_release): (i8, i8, i8, i8)) -> Self

Converts to this type from the input type.

impl From<(i16, i16, i16)> for Version

fn from((major, minor, patch): (i16, i16, i16)) -> Self

Converts to this type from the input type.

impl From<(i16, i16, i16, i16)> for Version

fn from((major, minor, patch, pre_release): (i16, i16, i16, i16)) -> Self

Converts to this type from the input type.

impl From<(i32, i32, i32)> for Version

fn from((major, minor, patch): (i32, i32, i32)) -> Self

Converts to this type from the input type.

impl From<(i32, i32, i32, i32)> for Version

fn from((major, minor, patch, pre_release): (i32, i32, i32, i32)) -> Self

Converts to this type from the input type.

impl From<(i64, i64, i64)> for Version

fn from((major, minor, patch): (i64, i64, i64)) -> Self

Converts to this type from the input type.

impl From<(i64, i64, i64, i64)> for Version

fn from((major, minor, patch, pre_release): (i64, i64, i64, i64)) -> Self

Converts to this type from the input type.

impl From<(isize, isize, isize)> for Version

fn from((major, minor, patch): (isize, isize, isize)) -> Self

Converts to this type from the input type.

impl From<(isize, isize, isize, isize)> for Version

fn from( (major, minor, patch, pre_release): (isize, isize, isize, isize), ) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8)> for Version

fn from((major, minor, patch): (u8, u8, u8)) -> Self

Converts to this type from the input type.

impl From<(u8, u8, u8, u8)> for Version

fn from((major, minor, patch, pre_release): (u8, u8, u8, u8)) -> Self

Converts to this type from the input type.

impl From<(u16, u16, u16)> for Version

fn from((major, minor, patch): (u16, u16, u16)) -> Self

Converts to this type from the input type.

impl From<(u16, u16, u16, u16)> for Version

fn from((major, minor, patch, pre_release): (u16, u16, u16, u16)) -> Self

Converts to this type from the input type.

impl From<(u32, u32, u32)> for Version

fn from((major, minor, patch): (u32, u32, u32)) -> Self

Converts to this type from the input type.

impl From<(u32, u32, u32, u32)> for Version

fn from((major, minor, patch, pre_release): (u32, u32, u32, u32)) -> Self

Converts to this type from the input type.

impl From<(u64, u64, u64)> for Version

fn from((major, minor, patch): (u64, u64, u64)) -> Self

Converts to this type from the input type.

impl From<(u64, u64, u64, u64)> for Version

fn from((major, minor, patch, pre_release): (u64, u64, u64, u64)) -> Self

Converts to this type from the input type.

impl From<(usize, usize, usize)> for Version

fn from((major, minor, patch): (usize, usize, usize)) -> Self

Converts to this type from the input type.

impl From<(usize, usize, usize, usize)> for Version

fn from( (major, minor, patch, pre_release): (usize, usize, usize, usize), ) -> Self

Converts to this type from the input type.

impl FromStr for Version

type Err = SemverError

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: &Version) -> 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 Version

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 Version

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