Enum tame_index::index::ComboIndexCache

#[non_exhaustive]
pub enum ComboIndexCache {
    Git(GitIndex),
    Sparse(SparseIndex),
    Local(LocalRegistry),
}

Provides simpler access to the cache for an index, regardless of the registry kind

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(GitIndex)

A git index

Sparse(SparseIndex)

A sparse HTTP index

Local(LocalRegistry)

Available on crate feature local only.

A local registry

Implementations

impl ComboIndexCache

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

Retrieves the index metadata for the specified crate name

pub fn cache_path(&self, name: KrateName<'_>) -> PathBuf

Gets the path to the cache entry for the specified crate

pub fn new(il: IndexLocation<'_>) -> Result<Self, Error>

Constructs a Self for the specified index.

See [Self::crates_io] if you want to create a crates.io index based upon other information in the user’s environment

Trait Implementations

impl From<GitIndex> for ComboIndexCache

fn from(gi: GitIndex) -> Self

Converts to this type from the input type.

impl From<SparseIndex> for ComboIndexCache

fn from(si: SparseIndex) -> Self

Converts to this type from the input type.