Struct PackageIdSpec

pub struct PackageIdSpec {
    name: String,
    version: Option<PartialVersion>,
    url: Option<Url>,
    kind: Option<SourceKind>,
}

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.

Fields

name: String

version: Option<PartialVersion>

url: Option<Url>

kind: Option<SourceKind>

Implementations

impl PackageIdSpec

pub fn new(name: String) -> PackageIdSpec

pub fn with_version(self, version: PartialVersion) -> PackageIdSpec

pub fn with_url(self, url: Url) -> PackageIdSpec

pub fn with_kind(self, kind: SourceKind) -> PackageIdSpec

pub fn parse(spec: &str) -> Result<PackageIdSpec, PackageIdSpecError>

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

Examples

Some examples of valid strings

use cargo_util_schemas::core::PackageIdSpec;

let specs = vec![
    "foo",
    "foo@1.4",
    "foo@1.4.3",
    "foo:1.2.3",
    "https://github.com/rust-lang/crates.io-index#foo",
    "https://github.com/rust-lang/crates.io-index#foo@1.4.3",
    "ssh://git@github.com/rust-lang/foo.git#foo@1.4.3",
    "file:///path/to/my/project/foo",
    "file:///path/to/my/project/foo#1.1.8"
];
for spec in specs {
    assert!(PackageIdSpec::parse(spec).is_ok());
}

pub fn name(&self) -> &str

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

Full semver::Version, if present

pub fn partial_version(&self) -> Option<&PartialVersion>

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

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

pub fn kind(&self) -> Option<&SourceKind>

pub fn set_kind(&mut self, kind: SourceKind)

Trait Implementations

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 Debug for PackageIdSpec

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PackageIdSpec

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

Formats the value using the given formatter.

impl Hash for PackageIdSpec

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 PackageIdSpec

fn cmp(&self, other: &PackageIdSpec) -> 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 PackageIdSpecQuery for PackageIdSpec

fn query_str<I>(spec: &str, i: I) -> CargoResult<PackageId>

where I: IntoIterator<Item = PackageId>,

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

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

Checks whether the given PackageId matches the PackageIdSpec.

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.

impl PartialEq for PackageIdSpec

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PackageIdSpec

impl StructuralPartialEq for PackageIdSpec

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 200 bytes