Struct Version

pub struct Version { /* private fields */ }

Represents a 4-part version number.

In binding, Copy is inherited, but it is omitted to avoid implicit copying in for loops, etc.

Example

use commonlibsse_ng::rel::version::Version;

let ver = Version::new(1, 6, 1170, 0);
assert_eq!(ver.major(), 1);
assert_eq!(ver.to_string(), "1.6.1170.0");

Implementations

impl Version

pub const fn default_const() -> Self

Create a empty version.

Examples

use commonlibsse_ng::rel::version::Version;

assert_eq!(Version::default_const(), Version::new(0, 0, 0, 0));

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

Creates a new Version from four components.

Example

use commonlibsse_ng::rel::version::Version;

let ver = Version::new(1, 2, 3, 4);
assert_eq!(ver.major(), 1);

pub const fn from_str_const(version: &str) -> Self

Parses a version string at compile time.

Panics

Errors are made under the following conditions.

• When there is no number after a point.
• If there are more than 4 numbers.
• When there is a non-numeric character (other than a dot).

Examples

use commonlibsse_ng::rel::version::{Version, VersionParseError};

assert_eq!(Version::from_str_const("1.2.3"), Version::new(1, 2, 3, 0));

// Panics
// assert_eq!(Version::from_str_const_("1.2.3.4.5")); // Too many numbers
// assert_eq!(Version::from_str_const("1.2.f.4.5")); // Invalid char `f`
// assert_eq!(Version::from_str_const("1.2.")); // Missing number

pub const fn major(&self) -> u16

Returns the major version component.

Examples

use commonlibsse_ng::rel::version::Version;

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.major(), 1);

pub const fn minor(&self) -> u16

Returns the minor version component.

Examples

use commonlibsse_ng::rel::version::Version;

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.minor(), 2);

pub const fn patch(&self) -> u16

Returns the patch version component.

Examples

use commonlibsse_ng::rel::version::Version;

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.patch(), 3);

pub const fn build(&self) -> u16

Returns the build version component.

Examples

use commonlibsse_ng::rel::version::Version;

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.build(), 4);

pub const fn pack(&self) -> u32

Packs the version into a 32-bit integer.

Examples

use commonlibsse_ng::rel::version::Version;

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.pack(), 16908340);

pub const fn unpack(packed: u32) -> Self

Unpacks a 32-bit integer into a Version.

pub const fn parts(&self) -> [u16; 4]

Gets the inner parts.

Example

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.parts(), [1, 2, 3, 4]);

pub fn to_address_library_string(&self) -> String

To address library file name string.

Example

let v = Version::new(1, 2, 3, 4);
assert_eq!(v.to_address_library_string(), "1-2-3-4");

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

fn default() -> Self

Returns the “default value” for a type.

impl Display for Version

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

Formats the value using the given formatter.

impl FromStr for Version

type Err = VersionParseError

The associated error which can be returned from parsing.

fn from_str(version: &str) -> Result<Self, Self::Err>

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

impl Hash for Version

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 Index<usize> for Version

type Output = u16

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Version

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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

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

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

impl StructuralPartialEq for Version