Skip to main content

## PackageIdSpec

# Struct PackageIdSpec

Source

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

Expand description

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§

Source§

### impl PackageIdSpec

Source

#### pub fn new(name: String) -> Self

Source

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

Source

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

Source

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

Source

#### 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());
    }

Source

#### fn from_url(url: Url) -> Result<PackageIdSpec, PackageIdSpecError>

Tries to convert a valid `Url` to a `PackageIdSpec`.

Source

#### pub fn name(&self) -> &str

Source

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

Full `semver::Version`, if present

Source

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

Source

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

Source

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

Source

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

Source

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

## Trait Implementations§

Source§

### impl Clone for PackageIdSpec

Source§

#### fn clone(&self) -> PackageIdSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for PackageIdSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

### impl Display for PackageIdSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Eq for PackageIdSpec

Source§

### impl Hash for PackageIdSpec

Source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
Source§

### impl Ord for PackageIdSpec

Source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 (const: unstable) · Source§

#### fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

#### fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

#### fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

### impl PartialEq for PackageIdSpec

Source§

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

Equality operator `==`. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator `!=`. Read more
Source§

### impl PartialOrd for PackageIdSpec

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
Source§

### impl Serialize for PackageIdSpec

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

### impl StructuralPartialEq for PackageIdSpec

## Auto Trait Implementations§

§

### impl Freeze for PackageIdSpec

§

### impl RefUnwindSafe for PackageIdSpec

§

### impl Send for PackageIdSpec

§

### impl Sync for PackageIdSpec

§

### impl Unpin for PackageIdSpec

§

### impl UnsafeUnpin for PackageIdSpec

§

### impl UnwindSafe for PackageIdSpec

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
§

### impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn compare(&self, key: &K) -> Ordering

Compare self to `key` and return their ordering.
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

#### fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

#### fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T> ToString for T
where T: Display + ?Sized,

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

## 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