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.

Methods

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.

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

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

fn from(other: Version) -> Version

Performs the conversion.

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

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

Performs the conversion.

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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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

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

Formats the value using the given formatter.

impl Debug for Version

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

Formats the value using the given formatter.

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.