Struct cargo::core::PackageIdSpec

pub struct PackageIdSpec { /* fields omitted */ }

Some or all of the data required to identify a package:

1. the package name (a String, required)
2. the package version (a Version, optional)
3. the package source (a Url, optional)

If any of the optional fields are omitted, then the package id may be ambiguous, there may be more than one package/version/url combo that will match. However, often just the name is sufficient to uniquely define a package id.

Methods

impl PackageIdSpec

pub fn parse(spec: &str) -> CargoResult<PackageIdSpec>

Parses a spec string and returns a PackageIdSpec if the string was valid.

Examples

Some examples of valid strings

use cargo::core::PackageIdSpec;

let specs = vec![
    "http://crates.io/foo#1.2.3",
    "http://crates.io/foo#bar:1.2.3",
    "crates.io/foo",
    "crates.io/foo#1.2.3",
    "crates.io/foo#bar",
    "crates.io/foo#bar:1.2.3",
    "foo",
    "foo:1.2.3",
];
for spec in specs {
    assert!(PackageIdSpec::parse(spec).is_ok());
}

pub fn query_str<I>(spec: &str, i: I) -> CargoResult<PackageId> where
    I: IntoIterator<Item = PackageId>, 

Roughly equivalent to PackageIdSpec::parse(spec)?.query(i)

pub fn from_package_id(package_id: PackageId) -> PackageIdSpec

Convert a PackageId to a PackageIdSpec, which will have both the Version and Url fields filled in.

pub fn name(&self) -> &str

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

pub fn url(&self) -> Option<&Url>

pub fn set_url(&mut self, url: Url)

pub fn matches(&self, package_id: PackageId) -> bool

Checks whether the given PackageId matches the PackageIdSpec.

pub fn query<I>(&self, i: I) -> CargoResult<PackageId> where
    I: IntoIterator<Item = PackageId>, 

Checks a list of PackageIds to find 1 that matches this PackageIdSpec. If 0, 2, or more are found, then this returns an error.

Trait Implementations

impl PartialOrd<PackageIdSpec> for PackageIdSpec

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialEq<PackageIdSpec> for PackageIdSpec

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

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

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

This method tests for !=.

impl Clone for PackageIdSpec

fn clone(&self) -> PackageIdSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for PackageIdSpec

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Eq for PackageIdSpec

impl Display for PackageIdSpec

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

Formats the value using the given formatter.

impl Debug for PackageIdSpec

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

Formats the value using the given formatter.

impl Hash for PackageIdSpec

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Serialize for PackageIdSpec

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for PackageIdSpec

fn deserialize<D>(d: D) -> Result<PackageIdSpec, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.