Struct Version

pub struct Version { /* private fields */ }

Represents a version and compatibility rules.

Implementations

impl Version

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

Creates a new version in the form major.minor.patch with a ruleset that is used to check other versions such that >=0.1.2, <0.2.0 or >=1.2.3, <2 depending on whether or not the major version is 0.

use distant_net::common::Version;

// Matching versions are compatible
let a = Version::new(1, 2, 3);
let b = Version::new(1, 2, 3);
assert!(a.is_compatible_with(&b));

// Version 1.2.3 is compatible with 1.2.4, but not the other way
let a = Version::new(1, 2, 3);
let b = Version::new(1, 2, 4);
assert!(a.is_compatible_with(&b));
assert!(!b.is_compatible_with(&a));

// Version 1.2.3 is compatible with 1.3.0, but not 2
let a = Version::new(1, 2, 3);
assert!(a.is_compatible_with(&Version::new(1, 3, 0)));
assert!(!a.is_compatible_with(&Version::new(2, 0, 0)));

// Version 0.1.2 is compatible with 0.1.3, but not the other way
let a = Version::new(0, 1, 2);
let b = Version::new(0, 1, 3);
assert!(a.is_compatible_with(&b));
assert!(!b.is_compatible_with(&a));

// Version 0.1.2 is not compatible with 0.2
let a = Version::new(0, 1, 2);
let b = Version::new(0, 2, 0);
assert!(!a.is_compatible_with(&b));
assert!(!b.is_compatible_with(&a));

pub fn is_compatible_with(&self, other: &Self) -> bool

Returns true if this version is compatible with another version.

pub const fn from_be_bytes(bytes: [u8; 24]) -> Self

Converts from a collection of bytes into a version using the byte form major/minor/patch using big endian.

pub const fn to_be_bytes(&self) -> [u8; 24]

Converts the version into a byte form of major/minor/patch using big endian.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a duplicate of the value.

const 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

Default version is 0.0.0.

impl Display for Version

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

Formats the value using the given formatter.

impl From<Version> for Version

fn from(version: Version) -> Self

Creates a new Version using the major, minor, and patch information from semver::Version.

impl From<Version> for Version

fn from(version: Version) -> Self

Converts to this type from the input type.