Struct Version 

pub struct Version {
    pub major: u64,
    pub minor: u64,
    pub patch: u64,
    pub pre_release: PreRelease,
    pub build: BuildMetadata,
}

A parsed semantic version.

Build metadata is stored and included in the version’s string form. Direct Version comparison ignores build metadata. Use Version::cmp_build when build metadata should be used as a tiebreaker.

Examples

use js_semver::Version;

let version = Version::parse("19.3.0-canary-044d56f3-20260330").unwrap();

assert_eq!(version.major, 19);
assert_eq!(version.minor, 3);
assert_eq!(version.patch, 0);
assert_eq!(version.to_string(), "19.3.0-canary-044d56f3-20260330");

Fields

major: u64

The major version number.

minor: u64

The minor version number.

patch: u64

The patch version number.

pre_release: PreRelease

The pre-release identifiers, if any.

build: BuildMetadata

The build metadata identifiers, if any.

Implementations

impl Version

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

Create a new Version with no pre-release or build metadata.

Examples

use js_semver::Version;

let version = Version::new(1, 2, 3);

assert_eq!(version.to_string(), "1.2.3");
assert!(version.pre_release.is_empty());
assert!(version.build.is_empty());

pub fn parse(s: &str) -> Result<Self, SemverError>

Parse a version string.

Examples

use js_semver::Version;

let version = Version::parse("1.2.3-alpha.1").unwrap();

assert_eq!(version.major, 1);
assert_eq!(version.minor, 2);
assert_eq!(version.patch, 3);
assert_eq!(version.pre_release.to_string(), "alpha.1");

Errors

Returns SemverError if s is not a valid semver string.

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

Compare semantic version precedence with build metadata as a tiebreaker.

This is equivalent to node-semver’s compareBuild().

Examples

use core::cmp::Ordering;
use js_semver::Version;

let left: Version = "1.2.3+build.1".parse().unwrap();
let right: Version = "1.2.3+build.2".parse().unwrap();

assert_eq!(left.cmp(&right), Ordering::Equal);
assert_eq!(left.cmp_build(&right), Ordering::Less);

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

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Version

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

Equality operator ==.

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

Inequality operator !=.

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.