Struct version_check::Version

pub struct Version(_);

Version number: major.minor.patch, ignoring release channel.

Methods

impl Version

pub fn read() -> Option<Version>

Reads the version of the running compiler. If it cannot be determined (see the top-level documentation), returns None.

Example

use version_check::Version;

match Version::read() {
    Some(d) => format!("Version is: {}", d),
    None => format!("Failed to read the version.")
};

pub fn parse(version: &str) -> Option<Version>

Parse a Rust release version (of the form major[.minor[.patch[-channel]]]), ignoring the release channel, if any. Returns None if version is not a valid Rust version string.

Example

use version_check::Version;

let version = Version::parse("1.18.0").unwrap();
assert!(version.exactly("1.18.0"));

let version = Version::parse("1.20.0-nightly").unwrap();
assert!(version.exactly("1.20.0"));
assert!(version.exactly("1.20.0-beta"));

let version = Version::parse("1.3").unwrap();
assert!(version.exactly("1.3.0"));

let version = Version::parse("1").unwrap();
assert!(version.exactly("1.0.0"));

assert!(Version::parse("one.two.three").is_none());

pub fn at_least(&self, version: &str) -> bool

Returns true if self is greater than or equal to version.

If version is greater than self, or if version is not a valid Rust version string, returns false.

Example

use version_check::Version;

let version = Version::parse("1.35.0").unwrap();

assert!(version.at_least("1.33.0"));
assert!(version.at_least("1.35.0"));
assert!(version.at_least("1.13.2"));

assert!(!version.at_least("1.35.1"));
assert!(!version.at_least("1.55.0"));

pub fn at_most(&self, version: &str) -> bool

Returns true if self is less than or equal to version.

If version is less than self, or if version is not a valid Rust version string, returns false.

Example

use version_check::Version;

let version = Version::parse("1.35.0").unwrap();

assert!(version.at_most("1.35.1"));
assert!(version.at_most("1.55.0"));
assert!(version.at_most("1.35.0"));

assert!(!version.at_most("1.33.0"));
assert!(!version.at_most("1.13.2"));

pub fn exactly(&self, version: &str) -> bool

Returns true if self is exactly equal to version.

If version is not equal to self, or if version is not a valid Rust version string, returns false.

Example

use version_check::Version;

let version = Version::parse("1.35.0").unwrap();

assert!(version.exactly("1.35.0"));

assert!(!version.exactly("1.33.0"));
assert!(!version.exactly("1.35.1"));
assert!(!version.exactly("1.13.2"));

Trait Implementations

impl PartialEq<Version> for Version

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

fn cmp(&self, other: &Version) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Version

impl Copy for Version

impl PartialOrd<Version> 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: &Version) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Version

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

Formats the value using the given formatter.

impl Display for Version

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

Formats the value using the given formatter.