Struct SpecVersion

pub struct SpecVersion { /* private fields */ }

Description of a version of the FEF specification.

Holds information about the major, minor, and micro version of the FEF specification.

Examples

Getting a version string:

let version = fef::common::version::SpecVersion::new(1, 2, 3);
assert_eq!(format!("{}", version), "v1.2.3");

Implementations

impl SpecVersion

pub const fn new(major: u32, minor: u32, micro: u32) -> SpecVersion

Creates a new SpecVersion with the given major, minor, and micro version numbers.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(version.major(), 1);
assert_eq!(version.minor(), 2);
assert_eq!(version.micro(), 3);

pub const fn major(&self) -> u32

Returns the major version number.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(version.major(), 1);

pub const fn minor(&self) -> u32

Returns the minor version number.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(version.minor(), 2);

pub const fn micro(&self) -> u32

Returns the micro version number.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(version.micro(), 3);

Trait Implementations

impl Clone for SpecVersion

fn clone(&self) -> SpecVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecVersion

Formats the version as a string when displayed in the format “SpecVersion({MAJOR}.{MINOR}.{MICRO})”.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(format!("{:?}", version), "SpecVersion(1.2.3)");

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

Formats the value using the given formatter.

impl Default for SpecVersion

Implements the default value for SpecVersion as SpecVersion(0.0.0).

Examples

let version = SpecVersion::default();
assert_eq!(version, SpecVersion::new(0, 0, 0));

fn default() -> Self

Returns the “default value” for a type.

impl Display for SpecVersion

Formats the version as a string when displayed in the format “v{MAJOR}.{MINOR}.{MICRO}”.

Examples

let version = SpecVersion::new(1, 2, 3);
assert_eq!(format!("{}", version), "v1.2.3");

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

Formats the value using the given formatter.

impl Hash for SpecVersion

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 SpecVersion

Versions are ordered by their major, minor, and micro version numbers lexicographically.

Examples

let version1 = SpecVersion::new(1, 2, 3);
let version2 = SpecVersion::new(1, 2, 4);
let version3 = SpecVersion::new(1, 3, 0);
let version4 = SpecVersion::new(2, 0, 0);

assert!(version1 < version2);
assert!(version2 < version3);
assert!(version3 < version4);

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 SpecVersion

fn partial_cmp(&self, other: &Self) -> 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 SpecVersion

impl Eq for SpecVersion

impl StructuralPartialEq for SpecVersion