Struct cargo::util::CanonicalUrl

pub struct CanonicalUrl(_);

A newtype wrapper around Url which represents a "canonical" version of an original URL.

A "canonical" url is only intended for internal comparison purposes in Cargo. It's to help paper over mistakes such as depending on github.com/foo/bar vs github.com/foo/bar.git. This is only for internal purposes within Cargo and provides no means to actually read the underlying string value of the Url it contains. This is intentional, because all fetching should still happen within the context of the original URL.

Implementations

impl CanonicalUrl

pub fn new(url: &Url) -> CargoResult<CanonicalUrl>

pub fn raw_canonicalized_url(&self) -> &Url

Returns the raw canonicalized URL, although beware that this should never be used/displayed/etc, it should only be used for internal data structures and hashes and such.

Trait Implementations

impl Clone for CanonicalUrl

fn clone(&self) -> CanonicalUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalUrl

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

Formats the value using the given formatter.

impl Eq for CanonicalUrl

impl Hash for CanonicalUrl

fn hash<S: Hasher>(&self, into: &mut S)

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 Ord for CanonicalUrl

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<CanonicalUrl> for CanonicalUrl

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

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

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

This method tests for !=.

impl PartialOrd<CanonicalUrl> for CanonicalUrl

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for CanonicalUrl

impl StructuralPartialEq for CanonicalUrl