Struct version_number::BaseVersion

pub struct BaseVersion {
    pub major: u64,
    pub minor: u64,
}

A two-component MAJOR.MINOR version.

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

If you require a version number which also includes the PATCH number, please see the FullVersion variant. For a semver compliant parser, you should use the semver crate instead.

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.

Implementations

impl BaseVersion

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

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

See BaseVersion for more.

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

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

Returns a ParserError if it fails to parse.

pub fn to_full_version_lossy(self) -> FullVersion

Convert this base version to a full version.

This conversion is lossy because the patch value is not known to this BaseVersion, and will initialize as 0.

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

where F: FnOnce(Self) -> U,

Map a BaseVersion to U.

Example

use version_number::BaseVersion;

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

let example = BaseVersion::new(1, 2);

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

Trait Implementations

impl Clone for BaseVersion

fn clone(&self) -> BaseVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaseVersion

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

Formats the value using the given formatter.

impl Display for BaseVersion

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

Formats the value using the given formatter.

impl From<(u64, u64)> for BaseVersion

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

Converts to this type from the input type.

impl Hash for BaseVersion

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 BaseVersion

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

Restrict a value to a certain interval.

impl PartialEq for BaseVersion

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BaseVersion

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

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

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

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

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

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

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

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

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 Copy for BaseVersion

impl Eq for BaseVersion

impl StructuralPartialEq for BaseVersion