Enum ComboIndex

#[non_exhaustive]
pub enum ComboIndex {
    Git(RemoteGitIndex),
    Sparse(RemoteSparseIndex),
    Local(LocalRegistry),
}

Available on crate features __git and sparse only.

A wrapper around either a RemoteGitIndex or RemoteSparseIndex

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Git(RemoteGitIndex)

A standard git based registry index. No longer the default for crates.io as of 1.70.0

Sparse(RemoteSparseIndex)

An HTTP sparse index

Local(LocalRegistry)

Available on crate feature local only.

A local registry

Implementations

impl ComboIndex

pub fn krate( &self, name: KrateName<'_>, write_cache_entry: bool, lock: &FileLock, ) -> Result<Option<IndexKrate>, Error>

Retrieves the index metadata for the specified crate name, optionally writing a cache entry for it if there was not already an up to date one

Note no cache entry is written if this is a Local registry as they do not use .cache files

pub fn cached_krate( &self, name: KrateName<'_>, lock: &FileLock, ) -> Result<Option<IndexKrate>, Error>

Retrieves the cached crate metadata if it exists

Trait Implementations

impl From<LocalRegistry> for ComboIndex

Available on crate feature local only.

fn from(local: LocalRegistry) -> Self

Converts to this type from the input type.

impl From<RemoteGitIndex> for ComboIndex

fn from(index: RemoteGitIndex) -> Self

Converts to this type from the input type.

impl From<RemoteSparseIndex> for ComboIndex

fn from(index: RemoteSparseIndex) -> Self

Converts to this type from the input type.