Struct semver_constraints::Constraint

pub struct Constraint { /* fields omitted */ }

A set of Ranges combines to make a Constraint. Constraints are the union of multiple Ranges. Upon manual creation or updating of a Constraint, the Constraint will unify all of its Ranges such that all of the Ranges are disjoint. Unification is eager: it's done whenever the set is modified to keep the internal representation of the set unified at all times (this is useful for converting the Constraint to a string, since the Display trait doesn't allow mutating self).

Syntax-wise, a Constraint is just a list of comma-separated ranges.

Methods

impl Constraint

pub fn new(ranges: IndexSet<Range>) -> Constraint

Creates a new Constraint from a set of Ranges.

pub fn empty() -> Constraint

pub fn any() -> Constraint

pub fn insert(&mut self, range: Range)

Inserts a Range into the set.

pub fn retrieve(&self) -> &IndexSet<Range>

Borrows the set of Ranges from this struct, unifying it in the process.

pub fn take(self) -> IndexSet<Range>

Takes the set of Ranges from this struct, unifying it in the process.

pub fn unify(&mut self)

Unifies all of the ranges in the set such that all of the ranges are disjoint.

pub fn is_empty(&self) -> bool

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

Checks if a Version is satisfied by this Constraint.

pub fn intersection(&self, other: &Constraint) -> Constraint

pub fn union(&self, other: &Constraint) -> Constraint

pub fn difference(&self, other: &Constraint) -> Constraint

pub fn complement(&self) -> Constraint

pub fn relation(&self, other: &Constraint) -> Relation

Trait Implementations

impl PartialEq<Constraint> for Constraint

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

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

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

This method tests for !=.

impl Default for Constraint

fn default() -> Self

Returns the "default value" for a type.

impl From<Range> for Constraint

fn from(r: Range) -> Constraint

Performs the conversion.

impl From<Version> for Constraint

fn from(v: Version) -> Constraint

Performs the conversion.

impl Clone for Constraint

fn clone(&self) -> Constraint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Constraint

impl Display for Constraint

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

Formats the value using the given formatter.

impl Debug for Constraint

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

Formats the value using the given formatter.

impl FromStr for Constraint

type Err = Error

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.