Struct Relation 

pub struct Relation(/* private fields */);

A node in the syntax tree representing a $ast

Implementations

impl Relation

pub fn new( name: &str, version_constraint: Option<(VersionConstraint, Version)>, ) -> Self

Create a new relation

Arguments

• name - The name of the package
• version_constraint - The version constraint and version to use

Example

use r_description::lossless::{Relation};
use r_description::VersionConstraint;
let relation = Relation::new("vign", Some((VersionConstraint::GreaterThanEqual, "2.0".parse().unwrap())));
assert_eq!(relation.to_string(), "vign (>= 2.0)");

pub fn wrap_and_sort(&self) -> Self

Wrap and sort this relation

Example

use r_description::lossless::Relation;
let relation = "  vign  (  >= 2.0) ".parse::<Relation>().unwrap();
assert_eq!(relation.wrap_and_sort().to_string(), "vign (>= 2.0)");

pub fn simple(name: &str) -> Self

Create a new simple relation, without any version constraints.

Example

use r_description::lossless::Relation;
let relation = Relation::simple("vign");
assert_eq!(relation.to_string(), "vign");

pub fn drop_constraint(&mut self) -> bool

Remove the version constraint from the relation.

Example

use r_description::lossless::{Relation};
use r_description::VersionConstraint;
let mut relation = Relation::new("vign", Some((VersionConstraint::GreaterThanEqual, "2.0".parse().unwrap())));
relation.drop_constraint();
assert_eq!(relation.to_string(), "vign");

pub fn name(&self) -> String

Return the name of the package in the relation.

Example

use r_description::lossless::Relation;
let relation = Relation::simple("vign");
assert_eq!(relation.name(), "vign");

pub fn version(&self) -> Option<(VersionConstraint, Version)>

Return the version constraint and the version it is constrained to.

pub fn set_version( &mut self, version_constraint: Option<(VersionConstraint, Version)>, )

Set the version constraint for this relation

Example

use r_description::lossless::{Relation};
use r_description::VersionConstraint;
let mut relation = Relation::simple("vign");
relation.set_version(Some((VersionConstraint::GreaterThanEqual, "2.0".parse().unwrap())));
assert_eq!(relation.to_string(), "vign (>= 2.0)");

pub fn remove(&mut self)

Remove this relation

Example

use r_description::lossless::{Relation, Relations};
let mut relations: Relations = r"cli (>= 0.19.0), blah (<< 1.26.0)".parse().unwrap();
let mut relation = relations.get_relation(0).unwrap();
assert_eq!(relation.to_string(), "cli (>= 0.19.0)");
relation.remove();
assert_eq!(relations.to_string(), "blah (<< 1.26.0)");

pub fn satisfied_by(&self, package_version: impl VersionLookup + Copy) -> bool

Check if this relation is satisfied by the given package version.

Trait Implementations

impl Debug for Relation

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

Formats the value using the given formatter.

impl Display for Relation

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

Formats the value using the given formatter.

impl From<Relation> for Relation

fn from(relation: Relation) -> Self

Converts to this type from the input type.

impl From<Relation> for Relation

fn from(relation: Relation) -> Self

Converts to this type from the input type.

impl From<Relation> for Relations

fn from(relation: Relation) -> Self

Converts to this type from the input type.

impl FromStr for Relation

type Err = String

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.

impl Ord for Relation

fn cmp(&self, other: &Self) -> 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 Relation

fn eq(&self, other: &Self) -> 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 Relation

fn partial_cmp(&self, other: &Self) -> 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 Eq for Relation