Struct Range

pub struct Range {
    pub predicates: Vec<Predicate>,
}

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

Fields

predicates: Vec<Predicate>

Implementations

impl Range

pub fn any() -> Range

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

Examples

use reproto_semver::Range;

let anything = Range::any();

pub fn parse(input: &str) -> Result<Range, Error<'_>>

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

A Result is returned which contains a Error if there was a problem parsing the Range.

Examples

use reproto_semver::Range;

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

This example demonstrates error handling, and will panic.

use reproto_semver::Range;

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

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

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

Examples

use reproto_semver::Range;
use reproto_semver::Version;

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

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

matches() matches a given Version against this Range.

Examples

use reproto_semver::Range;
use reproto_semver::Version;

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

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

pub fn matches_any(&self) -> bool

Check if range matches any.

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Range

fn deserialize<D>( deserializer: D, ) -> Result<Range, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Range

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

Formats the value using the given formatter.

impl Hash for Range

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Range

fn cmp(&self, other: &Range) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Range

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Range

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Range

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Range

impl StructuralPartialEq for Range