Struct EncodableSourceId

pub struct EncodableSourceId {
    inner: SourceId,
    encoded: bool,
}

Pretty much equivalent to SourceId with a different serialization method.

The serialization for SourceId doesn’t do URL encode for parameters. In contrast, this type is aware of that whenever ResolveVersion allows us to do so (v4 or later).

Fields

inner: SourceId

encoded: bool

We don’t care about the deserialization of this, as the url crate will always decode as the URL was encoded. Only when a Resolve turns into a EncodableResolve will it set the value accordingly via encodable_source_id.

Implementations

impl EncodableSourceId

fn new(inner: SourceId) -> Self

Creates a EncodableSourceId that always encodes URL params.

fn without_url_encoded(inner: SourceId) -> Self

Creates a EncodableSourceId that doesn’t encode URL params. This is for backward compatibility for order lockfile version.

fn as_url(&self) -> impl Display + '_

Encodes the inner SourceId as a URL.

Methods from Deref<Target = SourceId>

pub fn as_url(&self) -> SourceIdAsUrl<'_>

A view of the SourceId that can be Displayed as a URL.

pub fn as_encoded_url(&self) -> SourceIdAsUrl<'_>

Like Self::as_url but with URL parameters encoded.

pub fn url(&self) -> &Url

Gets this source URL.

pub fn canonical_url(&self) -> &CanonicalUrl

Gets the canonical URL of this source, used for internal comparison purposes.

pub fn alt_registry_key(&self) -> Option<&str>

Gets the name of the remote registry as defined in the [registries] table, or the built-in crates-io key.

pub fn kind(&self) -> &SourceKind

Trait Implementations

impl Clone for EncodableSourceId

fn clone(&self) -> EncodableSourceId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodableSourceId

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

Formats the value using the given formatter.

impl Deref for EncodableSourceId

type Target = SourceId

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for EncodableSourceId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for EncodableSourceId

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EncodableSourceId

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

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 EncodableSourceId

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EncodableSourceId

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: 16 bytes