Struct semver::Version

pub struct Version {
    pub major: u64,
    pub minor: u64,
    pub patch: u64,
    pub pre: Vec<Identifier>,
    pub build: Vec<Identifier>,
}

Represents a version number conforming to the semantic versioning scheme.

Fields

major: u64

The major version, to be incremented on incompatible changes.

minor: u64

The minor version, to be incremented when functionality is added in a backwards-compatible manner.

patch: u64

The patch version, to be incremented when backwards-compatible bug fixes are made.

pre: Vec<Identifier>

The pre-release version identifier, if one exists.

build: Vec<Identifier>

The build metadata, ignored when determining version precedence.

Implementations

impl Version

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

Contructs the simple case without pre or build.

pub fn parse(version: &str) -> Result<Version, SemVerError>

Parse a string into a semver object.

Errors

Returns an error variant if the input could not be parsed as a semver object.

In general, this means that the provided string does not conform to the semver spec.

An error for overflow is returned if any numeric component is larger than what can be stored in u64.

The following are examples for other common error causes:

• 1.0 - too few numeric components are used. Exactly 3 are expected.
• 1.0.01 - a numeric component has a leading zero.
• 1.0.foo - uses a non-numeric components where one is expected.
• 1.0.0foo - metadata is not separated using a legal character like, + or -.
• 1.0.0+foo_123 - contains metadata with an illegal character (_). Legal characters for metadata include a-z, A-Z, 0-9, -, and . (dot).

pub fn increment_patch(&mut self)

Increments the patch number for this Version (Must be mutable)

pub fn increment_minor(&mut self)

Increments the minor version number for this Version (Must be mutable)

As instructed by section 7 of the spec, the patch number is reset to 0.

pub fn increment_major(&mut self)

Increments the major version number for this Version (Must be mutable)

As instructed by section 8 of the spec, the minor and patch numbers are reset to 0

pub fn is_prerelease(&self) -> bool

Checks to see if the current Version is in pre-release status

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

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

Formats the value using the given formatter.

impl Eq for Version

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

fn from(tuple: (u64, u64, u64)) -> Version

Performs the conversion.

impl From<Version> for Version

fn from(other: Version) -> Version

Performs the conversion.

impl FromStr for Version

type Err = SemVerError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Version, SemVerError>

Parses a string s to return a value of this type.

impl Hash for Version

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

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Version> for Version

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Version> for Version

fn partial_cmp(&self, other: &Version) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 StructuralEq for Version