Struct SparseIndex

pub struct SparseIndex { /* private fields */ }

Wrapper around managing a sparse HTTP index, re-using Cargo’s local disk caches.

This implementation does no network I/O at all. If you want to make requests to the remote index you may use the Self::make_remote_request and Self::parse_remote_response methods, or you can enable the sparse feature and and use RemoteSparseIndex or AsyncRemoteSparseIndex

Implementations

impl SparseIndex

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

Creates a new sparse index for the specified location

pub fn index_config(&self) -> Result<IndexConfig, Error>

Get the configuration of the index.

See the cargo docs

pub fn crate_url(&self, name: KrateName<'_>) -> String

Get the URL that can be used to fetch the index entry for the specified crate

The body of a successful response for the returned URL can be parsed via IndexKrate::from_slice

See Self::make_remote_request for a way to make a complete request

pub fn url(&self) -> &str

The HTTP url of the index

pub fn cache(&self) -> &IndexCache

Gets the accessor to the local index cache

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

Attempts to read the locally cached crate information

pub fn make_remote_request( &self, name: KrateName<'_>, etag: Option<&str>, lock: &FileLock, ) -> Result<Request<()>, Error>

Creates an HTTP request that can be sent via your HTTP client of choice to retrieve the current metadata for the specified crate

If specified, the etag is used instead of the possible etag stored in a local cache entry, resulting in no disk I/O being performed by this method

See Self::parse_remote_response processing the response from the remote index

It is highly recommended to assume HTTP/2 when making requests to remote indices, at least crates.io

pub fn parse_remote_response( &self, name: KrateName<'_>, response: Response<Vec<u8>>, write_cache_entry: bool, lock: &FileLock, ) -> Result<Option<IndexKrate>, Error>

Process the response to a request created by Self::make_remote_request

This handles both the scenario where the local cache is missing the specified crate, or it is out of date, as well as the local entry being up to date and can just be read from disk

You may specify whether an updated index entry is written locally to the cache or not

Note that responses from sparse HTTP indices, at least crates.io, may send responses with gzip compression, it is your responsibility to decompress it before sending to this function

Trait Implementations

impl From<SparseIndex> for ComboIndexCache

fn from(si: SparseIndex) -> Self

Converts to this type from the input type.