Struct Channel

Source

pub struct Channel(/* private fields */);

Expand description

Release channel: “dev”, “nightly”, “beta”, or “stable”.

Implementations§

Source §

impl Channel

Source

pub fn read() -> Option<Channel>

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

§Example

use version_check::Channel;

match Channel::read() {
    Some(c) => format!("The channel is: {}", c),
    None => format!("Failed to read the release channel.")
};

Source

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

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

§Example

use version_check::Channel;

let dev = Channel::parse("1.3.0-dev").unwrap();
assert!(dev.is_dev());

let nightly = Channel::parse("1.42.2-nightly").unwrap();
assert!(nightly.is_nightly());

let beta = Channel::parse("1.32.0-beta").unwrap();
assert!(beta.is_beta());

let stable = Channel::parse("1.4.0").unwrap();
assert!(stable.is_stable());

Source

pub fn supports_features(&self) -> bool

Returns true if this channel supports feature flags. In other words, returns true if the channel is either dev or nightly.

Please see the note on feature detection.

§Example

use version_check::Channel;

let dev = Channel::parse("1.3.0-dev").unwrap();
assert!(dev.supports_features());

let nightly = Channel::parse("1.42.2-nightly").unwrap();
assert!(nightly.supports_features());

let beta = Channel::parse("1.32.0-beta").unwrap();
assert!(!beta.supports_features());

let stable = Channel::parse("1.4.0").unwrap();
assert!(!stable.supports_features());

Source

pub fn is_dev(&self) -> bool

Returns true if this channel is dev and false otherwise.

§Example

use version_check::Channel;

let dev = Channel::parse("1.3.0-dev").unwrap();
assert!(dev.is_dev());

let stable = Channel::parse("1.0.0").unwrap();
assert!(!stable.is_dev());

Source

pub fn is_nightly(&self) -> bool

Returns true if this channel is nightly and false otherwise.

§Example

use version_check::Channel;

let nightly = Channel::parse("1.3.0-nightly").unwrap();
assert!(nightly.is_nightly());

let stable = Channel::parse("1.0.0").unwrap();
assert!(!stable.is_nightly());

Source

pub fn is_beta(&self) -> bool

Returns true if this channel is beta and false otherwise.

§Example

use version_check::Channel;

let beta = Channel::parse("1.3.0-beta").unwrap();
assert!(beta.is_beta());

let stable = Channel::parse("1.0.0").unwrap();
assert!(!stable.is_beta());

Source

pub fn is_stable(&self) -> bool

Returns true if this channel is stable and false otherwise.

§Example

use version_check::Channel;

let stable = Channel::parse("1.0.0").unwrap();
assert!(stable.is_stable());

let beta = Channel::parse("1.3.0-beta").unwrap();
assert!(!beta.is_stable());