Struct Range 

pub struct Range { /* private fields */ }

A version range, e.g. ^1.0.0 or >=1.0.0 <2.0.0-0.

Its string form preserves the parsed comparator structure, but may differ from the original input when wildcards, build metadata, or unrestricted unions are simplified away.

Examples

use js_semver::Range;

assert_eq!(Range::parse("^1.2.3").unwrap().to_string(), ">=1.2.3 <2.0.0-0");
assert_eq!(Range::parse("^1.2.3 || *").unwrap().to_string(), "*");
assert_eq!(Range::parse("1.x.x+experimental").unwrap().to_string(), ">=1.0.0 <2.0.0-0");

Implementations

impl Range

pub fn parse(s: &str) -> Result<Self, SemverError>

Parse a range string.

The parsed range is displayed in canonical comparator form.

Examples

use js_semver::Range;

assert_eq!(Range::parse("^1.2.3").unwrap().to_string(), ">=1.2.3 <2.0.0-0");
assert_eq!(Range::parse(">=2.0.0").unwrap().to_string(), ">=2.0.0");

Errors

Returns SemverError if s is not a valid semver range string.

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

Returns true if the given Version satisfies this range.

This follows node-semver’s prerelease restriction rule: a prerelease version only matches when the range contains a comparator with the same major.minor.patch tuple and an explicit prerelease.

Examples

use js_semver::{Range, Version};

let range = Range::parse("^1.2.3").unwrap();

assert!(range.satisfies(&Version::parse("1.5.0").unwrap()));
assert!(!range.satisfies(&Version::parse("2.0.0").unwrap()));

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a duplicate 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

Formats the value using the given formatter.

impl Display for Range

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

Formats the value using the given formatter.

impl FromStr for Range

type Err = SemverError

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.