Struct FullVersion

pub struct FullVersion {
    pub major: u64,
    pub minor: u64,
    pub patch: u64,
}

A three-component MAJOR.MINOR.PATCH version.

This version number is a subset of semver. In particular, it consists of the MAJOR. MINOR and PATCH components, and leaves out the additional labels for pre-release and build metadata.

If you require a version number which also discards the PATCH number, please see the BaseVersion variant.

For a semver compliant parser, you should use the semver crate instead.

Converting to a semver::Version

This version type may be converted to a semver::Version using the From trait, assuming the semver feature is enabled.

Fields

major: u64

A major version is incremented when backwards incompatible changes are made to a public API.

When this number equals 0, the version is considered an unstable initial development version.

minor: u64

The minor version is incremented when backwards compatibles changes are made to a public API.

When the version number is considered an unstable initial development version, it may also be incremented for backwards incompatible changes.

patch: u64

The patch version is incremented when backwards compatibles bug fixes are made.

Implementations

impl FullVersion

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

Instantiate a three component, version number with MAJOR, MINOR and PATCH components.

See FullVersion for more.

pub fn parse(input: &str) -> Result<Self, ParserError>

Parse a three component, major.minor.patch version number from a given input.

Returns a ParserError if it fails to parse.

pub fn to_base_version_lossy(self) -> BaseVersion

Convert this full version to a base version.

This conversion is lossy because the patch value is lost upon conversion.

pub fn map<U, F>(self, fun: F) -> U

where F: FnOnce(Self) -> U,

Map a FullVersion to U.

Example

use version_number::FullVersion;

// 🧑‍🔬
fn invert_version(v: FullVersion) -> FullVersion {
    FullVersion::new(v.patch, v.minor, v.major)
}

let example = FullVersion::new(1, 2, 3);

assert_eq!(example.map(invert_version), FullVersion::new(3, 2, 1));

Trait Implementations

impl Clone for FullVersion

fn clone(&self) -> FullVersion

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullVersion

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

Formats the value using the given formatter.

impl Display for FullVersion

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl Hash for FullVersion

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 FullVersion

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

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

fn partial_cmp(&self, other: &FullVersion) -> 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 Copy for FullVersion

impl Eq for FullVersion

impl StructuralPartialEq for FullVersion