Struct semver::VersionReq

pub struct VersionReq { /* fields omitted */ }

A VersionReq is a struct containing a list of predicates that can apply to ranges of version numbers. Matching operations can then be done with the VersionReq against a particular version to see if it satisfies some or all of the constraints.

Methods

impl VersionReq

pub fn any() -> VersionReq

any() is a factory method which creates a VersionReq with no constraints. In other words, any version will match against it.

Examples

use semver::VersionReq;

let anything = VersionReq::any();

pub fn parse(input: &str) -> Result<VersionReq, ReqParseError>

parse() is the main constructor of a VersionReq. It takes a string like "^1.2.3" and turns it into a VersionReq that matches that particular constraint.

A Result is returned which contains a ReqParseError if there was a problem parsing the VersionReq.

Examples

use semver::VersionReq;

let version = VersionReq::parse("=1.2.3");
let version = VersionReq::parse(">1.2.3");
let version = VersionReq::parse("<1.2.3");
let version = VersionReq::parse("~1.2.3");
let version = VersionReq::parse("^1.2.3");
let version = VersionReq::parse("1.2.3"); // synonym for ^1.2.3
let version = VersionReq::parse("<=1.2.3");
let version = VersionReq::parse(">=1.2.3");

This example demonstrates error handling, and will panic.

use semver::VersionReq;

let version = match VersionReq::parse("not a version") {
    Ok(version) => version,
    Err(e) => panic!("There was a problem parsing: {}", e),
}

pub fn exact(version: &Version) -> VersionReq

exact() is a factory method which creates a VersionReq with one exact constraint.

Examples

use semver::VersionReq;
use semver::Version;

let version = Version { major: 1, minor: 1, patch: 1, pre: vec![], build: vec![] };
let exact = VersionReq::exact(&version);

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

matches() matches a given Version against this VersionReq.

Examples

use semver::VersionReq;
use semver::Version;

let version = Version { major: 1, minor: 1, patch: 1, pre: vec![], build: vec![] };
let exact = VersionReq::exact(&version);

assert!(exact.matches(&version));

Trait Implementations

impl Eq for VersionReq

impl Clone for VersionReq

fn clone(&self) -> VersionReq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<VersionReq> for VersionReq

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

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

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

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

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

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

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

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

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

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

impl PartialEq<VersionReq> for VersionReq

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

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

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

This method tests for !=.

impl From<VersionReq> for VersionReq

fn from(other: VersionReq) -> VersionReq

Performs the conversion.

impl Ord for VersionReq

fn cmp(&self, other: &VersionReq) -> 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 Hash for VersionReq

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Display for VersionReq

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

Formats the value using the given formatter.

impl Debug for VersionReq

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

Formats the value using the given formatter.

impl FromStr for VersionReq

type Err = ReqParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<VersionReq, ReqParseError>

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