Struct aloxide::Version

pub struct Version {
    pub major: u16,
    pub minor: u16,
    pub teeny: u16,
    pub pre: Option<Box<str>>,
}

A simple Ruby version.

Fields

major: u16

X.y.z.

minor: u16

x.Y.z.

teeny: u16

x.y.Z.

pre: Option<Box<str>>

The pre-release identifier for self.

Methods

impl Version

pub fn new(major: u16, minor: u16, teeny: u16) -> Self

Creates a new instance from major, minor, and teeny.

pub fn with_pre(
    major: u16,
    minor: u16,
    teeny: u16,
    pre: impl Into<Box<str>>
) -> Self

Creates a new instance from major, minor, teeny, and pre.

pub fn pre(&self) -> Option<&str>

Returns the pre-release identifier string for self.

pub fn current() -> Result<Self, RubyVersionError>

Attempts to get the version of the current Ruby found in PATH.

pub fn from_bin(ruby: impl AsRef<OsStr>) -> Result<Self, RubyVersionError>

Attempts to get the version of a ruby executable.

pub fn from_cmd(ruby: &mut Command) -> Result<Self, RubyVersionError>

Attempts to get the version of ruby by executing it.

pub fn parser() -> VersionParser

Returns a parser that can be used to construct a Version out of a string through various configurations.

pub fn archive_name(&self) -> String

Returns the name of the archive file corresponding to self.

pub fn url(&self) -> String

Returns an HTTPS URL for self.

Trait Implementations

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: &Self) -> 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<S: Into<Box<str>>> From<(u16, u16, u16, S)> for Version

fn from((major, minor, teeny, pre): (u16, u16, u16, S)) -> Self

Performs the conversion.

impl From<(u16, u16, u16)> for Version

fn from((major, minor, teeny): (u16, u16, u16)) -> Self

Performs the conversion.

impl From<(u16, u16)> for Version

fn from((major, minor): (u16, u16)) -> Self

Performs the conversion.

impl From<(u16,)> for Version

fn from((major): (u16,)) -> Self

Performs the conversion.

impl From<u16> for Version

fn from(major: u16) -> Version

Performs the conversion.

impl Eq for Version

impl PartialOrd<Version> for Version

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

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 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.

impl FromStr for Version

type Err = VersionParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'_> TryFrom<&'_ [u8]> for Version

type Error = VersionParseError

The type returned in the event of a conversion error.

fn try_from(b: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ CStr> for Version

type Error = VersionParseError

The type returned in the event of a conversion error.

fn try_from(s: &CStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ OsStr> for Version

type Error = VersionParseError

The type returned in the event of a conversion error.

fn try_from(s: &OsStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Version

type Error = VersionParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.