Struct semver::VersionReq
[−]
[src]
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
[src]
fn any() -> VersionReq
[src]
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();
fn parse(input: &str) -> Result<VersionReq, ReqParseError>
[src]
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),
}
fn exact(version: &Version) -> VersionReq
[src]
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);
fn matches(&self, version: &Version) -> bool
[src]
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 Clone for VersionReq
[src]
fn clone(&self) -> VersionReq
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for VersionReq
[src]
fn eq(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests for !=
.
impl Eq for VersionReq
[src]
impl PartialOrd for VersionReq
[src]
fn partial_cmp(&self, __arg_0: &VersionReq) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &VersionReq) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for VersionReq
[src]
fn cmp(&self, __arg_0: &VersionReq) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.22.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.22.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for VersionReq
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for VersionReq
[src]
impl From<VersionReq> for VersionReq
[src]
fn from(other: VersionReq) -> VersionReq
[src]
Performs the conversion.
impl FromStr for VersionReq
[src]
type Err = ReqParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<VersionReq, ReqParseError>
[src]
Parses a string s
to return a value of this type. Read more