Struct RemoteGitIndex

pub struct RemoteGitIndex { /* private fields */ }

Available on crate feature __git only.

Uses a “bare” git index that fetches files directly from the repo instead of using a local checkout, the same as cargo itself.

Uses cargo’s cache

Implementations

impl RemoteGitIndex

pub fn new(index: GitIndex, lock: &FileLock) -> Result<Self, Error>

Creates a new Self that can access and write local cache entries, and contact the remote index to retrieve the latest index information

Note that if a repository does not exist at the local disk path of the provided GitIndex, a full clone will be performed.

pub fn into_parts(self) -> (GitIndex, Repository)

Breaks Self into its component parts

This method is useful if you need thread safe access to the repository

pub fn with_options<P>( index: GitIndex, progress: P, should_interrupt: &AtomicBool, _lock: &FileLock, ) -> Result<Self, Error>

where P: NestedProgress, P::SubProgress: 'static,

Creates a new Self that allows showing of progress of the the potential fetch if the disk location is empty, as well as allowing interruption of the fetch operation.

pub fn local(&self) -> &GitIndex

Gets the local index

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

Get the configuration of the index.

See the cargo docs

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

Attempts to read the specified crate’s index metadata

An attempt is first made to read the cache entry for the crate, and falls back to reading the metadata from the git blob it is stored in

This method does no network I/O

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

Attempts to read the locally cached crate information

Note this method has improvements over using GitIndex::cached_krate.

In older versions of cargo, only the head commit hash is used as the version for cached crates, which means a fetch invalidates all cached crates, even if they have not been modified in any commits since the previous fetch.

This method does the same thing as cargo, which is to allow either the head commit oid or the blob oid as a version, which is more granular and means the cached crate can remain valid as long as it is not updated in a subsequent fetch. GitIndex::cached_krate cannot take advantage of that though as it does not have access to git and thus cannot know the blob id.

pub fn fetch(&mut self, lock: &FileLock) -> Result<(), Error>

Performs a fetch from the remote index repository.

This method performs network I/O.

pub fn fetch_with_options<P>( &mut self, progress: P, should_interrupt: &AtomicBool, _lock: &FileLock, ) -> Result<(), Error>

where P: NestedProgress, P::SubProgress: 'static,

Same as Self::fetch but allows specifying a progress implementation and allows interruption of the network operations

Trait Implementations

impl From<RemoteGitIndex> for ComboIndex

Available on crate feature sparse only.

fn from(index: RemoteGitIndex) -> Self

Converts to this type from the input type.