Struct Version

pub struct Version<T: Ord> {
    pub major: T,
    pub minor: T,
    pub patch: T,
    pub build: Option<T>,
}

A struct that represents a version consisting of major, minor, patch, and an optional build number.

The generic parameter T specifies the numerical type to use for each version component.

---

Examples

Creating a version without a build number:

use simple_version::Version;

let version: Version<u32> = Version::new(1, 2, 3);

---

Creating a version with a build number:

use simple_version::Version;

let version: Version<u32> = Version::new(1, 2, 3).build(4);

Fields

major: T

The major version component.

---

Examples

use simple_version::Version;

let mut version = Version::<u32>::new(1, 2, 3);
 
// read major version
println!("{}", version.major);
 
// set major version
version.major = 4;

minor: T

The minor version component.

---

Examples

use simple_version::Version;
 
let mut version = Version::<u32>::new(1, 2, 3);
 
// read minor version
println!("{}", version.minor);
 
// set minor version
version.minor = 4;

patch: T

The patch version component.

---

Examples

use simple_version::Version;
 
let mut version = Version::<u32>::new(1, 2, 3);
 
// read patch version
println!("{}", version.patch);
 
// set patch version
version.patch = 4;

build: Option<T>

The optional build number.

---

Examples

use simple_version::Version;
 
// version with a build number
let mut version = Version::<u32>::new(1, 2, 3).build(4);
 
// read build number
if let Some(build) = version.build {
    println!("{}", build);
}
 
// set build number
version.build = Some(5);

Implementations

impl<T: Ord> Version<T>

pub fn new(major: T, minor: T, patch: T) -> Version<T>

Creates a new Version<T> without a build number.

---

Arguments

• major: the major version component
• minor: the minor version component
• patch: the patch version component

---

Examples

use simple_version::Version;
 
let version: Version<u32> = Version::new(1, 2, 3);

pub fn build(self, build: T) -> Version<T>

Adds a build number to the existing version object and returns it.

---

Arguments

• build: the build number

---

Examples

use simple_version::Version;
 
let version: Version<u32> = Version::new(1, 2, 3).build(4);

Trait Implementations

impl<T: Debug + Ord> Debug for Version<T>

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

Formats the value using the given formatter.

impl<T: Ord + Display> Display for Version<T>

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

Formats the value using the given formatter.

impl<T: Ord + Ord> Ord for Version<T>

fn cmp(&self, other: &Version<T>) -> 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<T: PartialEq + Ord> PartialEq for Version<T>

fn eq(&self, other: &Version<T>) -> 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<T: PartialOrd + Ord> PartialOrd for Version<T>

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

impl<T: Ord> StructuralPartialEq for Version<T>