Enum IndexUrl

pub enum IndexUrl<'iu> {
    CratesIoSparse,
    CratesIoGit,
    NonCratesIo(Cow<'iu, str>),
    Local(Cow<'iu, Path>),
}

A remote index url

Variants

CratesIoSparse

The canonical crates.io HTTP sparse index.

See crate::CRATES_IO_HTTP_INDEX

CratesIoGit

The canonical crates.io git index.

See crate::CRATES_IO_INDEX

NonCratesIo(Cow<'iu, str>)

A non-crates.io index.

This variant uses the url to determine the index kind (sparse or git) by inspecting the url’s scheme. This is because sparse indices are required to have the sparse+ scheme modifier

Local(Cow<'iu, Path>)

A local registry

Implementations

impl<'iu> IndexUrl<'iu>

pub fn as_str(&'iu self) -> &'iu str

Gets the url as a string

pub fn is_sparse(&self) -> bool

Returns true if the url points to a sparse registry

pub fn crates_io( config_root: Option<PathBuf>, cargo_home: Option<&Path>, cargo_version: Option<&str>, ) -> Result<Self, Error>

Gets the IndexUrl for crates.io, depending on the local environment.

1. Determines if the crates.io registry has been replaced
2. Determines if the protocol was explicitly configured by the user
3. Otherwise, detects the version of cargo (see crate::utils::cargo_version), and uses that to determine the appropriate default

pub fn for_registry_name( config_root: Option<PathBuf>, cargo_home: Option<&Path>, registry_name: &str, ) -> Result<Self, Error>

Creates an IndexUrl for the specified registry name

1. Checks if CARGO_REGISTRIES_<name>_INDEX is set
2. Checks if the source for the registry has been replaced
3. Uses the value of registries.<name>.index otherwise

Trait Implementations

impl<'iu> Debug for IndexUrl<'iu>

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

Formats the value using the given formatter.

impl<'iu> Default for IndexUrl<'iu>

fn default() -> IndexUrl<'iu>

Returns the “default value” for a type.

impl<'iu> From<&'iu str> for IndexUrl<'iu>

fn from(s: &'iu str) -> Self

Converts to this type from the input type.