Struct Version

pub struct Version { /* private fields */ }

A struct representing a semantic version.

This struct contains three components of a version: major, minor, and patch. It derives common traits for easy comparison and manipulation.

Examples

Creating a new version:

use app_version::Version;

let version = Version::new(1,0,0);
assert_eq!(version.major(), 1);
assert_eq!(version.minor(), 0);
assert_eq!(version.patch(), 0);

Comparison

Versions can be compared for equality:

use app_version::Version;

let version1 = Version::new(1,0,0);
let version2 = Version::new(1,0,1);
assert_ne!(version1, version2);

Implementations

impl Version

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

Creates a new version.

Parameters

• major: The major version number.
• minor: The minor version number.
• patch: The patch version number.

Returns

A Version instance.

pub const fn major(&self) -> u16

Returns the major version number.

pub const fn minor(&self) -> u16

Returns the minor version number.

pub const fn patch(&self) -> u16

Returns the patch version number.

pub fn increment_patch(&mut self)

Increments the patch version.

pub fn increment_minor(&mut self)

Increments the minor version and resets patch to 0.

pub fn increment_major(&mut self)

Increments the major version and resets minor and patch to 0.

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

Checks if the current version is compatible with another version.

Parameters

• other: The other version to check compatibility against.

Returns

true if the versions are compatible, otherwise false.

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<(), Error>

Formats the value using the given formatter.

impl Default for Version

fn default() -> Version

Returns the “default value” for a type.

impl Display for Version

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl FromStr for Version

type Err = VersionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Version, <Version as FromStr>::Err>

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

impl PartialEq for Version

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

impl Eq for Version

impl StructuralPartialEq for Version