Skip to main content

VersionReq

Struct VersionReq 

Source
pub struct VersionReq { /* private fields */ }
Expand description

A version requirement such as ^1.2, >=1.0, <2.0 or 1.*: which versions are acceptable.

The syntax and the rules are Cargo’s. A requirement is comma-separated comparators that must all match. Operators: =, >, >=, <, <=, ~ (tilde: patch-level changes, or minor when the patch is omitted), ^ (caret: changes that keep the left-most non-zero number), and none, which means caret. 1, 1.2 and 1.2.3 may be partial; *, x and X are wildcards (1.*, 1.2.x, or * alone for anything). A pre-release version only matches a requirement that names a pre-release of the same MAJOR.MINOR.PATCH.

§Examples

use helpers4::version::{Version, VersionReq};

let req = VersionReq::parse("^1.2")?;
assert!(req.matches(&Version::parse("1.9.0")?));
assert!(!req.matches(&Version::parse("2.0.0")?));
assert!(!req.matches(&Version::parse("1.1.9")?));

let range = VersionReq::parse(">=1.0, <1.5")?;
assert!(range.matches(&Version::parse("1.4.9")?));

Implementations§

Source§

impl VersionReq

Source

pub fn parse(text: &str) -> Result<Self, ParseVersionError>

Parses a requirement.

§Arguments
  • text - The requirement, such as "^1.2", ">=1.0, <2.0" or "*".
§Errors

A ParseVersionError: Empty for an empty text, InvalidComparator for a malformed comparator (unknown operator, a wildcard with an operator other than =, a pre-release on a partial version, build metadata), or the number and identifier errors of Version::parse.

Source

pub fn matches(&self, version: &Version) -> bool

Whether version satisfies every comparator (and the pre-release rule).

§Arguments
  • version - The version to check.
§Returns

true when the version is acceptable.

Trait Implementations§

Source§

impl Clone for VersionReq

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VersionReq

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for VersionReq

Source§

impl PartialEq for VersionReq

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for VersionReq

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.