Struct CachedIndex

pub struct CachedIndex { /* private fields */ }

Available on crate feature git only.

Provides an efficient way to check if the given package has been yanked.

Operations on crates.io index are rather slow. Instead of peforming an index lookup for every version of every crate, this implementation looks up each crate only once and caches the result in memory.

Please note that this struct will hold a global Cargo package lock while it exists. Cargo operations that download crates (e.g. cargo update or even cargo build) will not be possible while this lock is held.

Implementations

impl CachedIndex

pub fn fetch( client: Option<ClientBuilder>, lock_timeout: Duration, ) -> Result<Self, Error>

Open the local crates.io index

If this opens a git index, it will perform a fetch to get the latest index information.

If this is a sparse index, it will be downloaded later on demand.

Locking

This function will wait for up to lock_timeout for the filesystem lock on the repository. It will fail with rustsec::Error::LockTimeout if the lock is still held after that time.

If lock_timeout is set to std::time::Duration::from_secs(0), it will not wait at all, and instead return an error immediately if it fails to aquire the lock.

pub fn open(lock_timeout: Duration) -> Result<Self, Error>

Open the local crates.io index

If this opens a git index, it allows reading of index entries from the repository.

If this is a sparse index, it only allows reading of index entries that are already cached locally.

Locking

This function will wait for up to lock_timeout for the filesystem lock on the repository. It will fail with rustsec::Error::LockTimeout if the lock is still held after that time.

If lock_timeout is set to std::time::Duration::from_secs(0), it will not wait at all, and instead return an error immediately if it fails to aquire the lock.

pub fn find_yanked<'a, I>( &mut self, packages: I, ) -> Vec<Result<&'a Package, Error>>

where I: IntoIterator<Item = &'a Package>,

Iterate over the provided packages, returning a vector of the packages which have been yanked.

This function should be called with many packages at once rather than one by one; that way it can download the status of a large number of packages at once from the sparse index very quickly, orders of magnitude faster than requesting packages one by one.