Struct GitIndex

pub struct GitIndex {
    pub head: Option<[u8; 40]>,
    /* private fields */
}

Allows access to a cargo git registry index

Uses Cargo’s cache.

Fields

head: Option<[u8; 40]>

The sha-1 head commit id encoded as hex

Implementations

impl GitIndex

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

Creates a new git index for the specified location

pub fn set_head_commit(&mut self, commit_id: Option<[u8; 20]>)

Sets the sha-1 id for the head commit.

If set, this will be used to disregard cache entries that do not match

pub fn head_commit(&self) -> Option<&str>

Gets the hex-encoded sha-1 id for the head commit

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

Reads a crate from the local cache of the index.

There are no guarantees around freshness, and no network I/O will be performed.

pub fn write_to_cache( &self, krate: &IndexKrate, blob_id: Option<&str>, lock: &FileLock, ) -> Result<Option<PathBuf>, Error>

Writes the specified crate to the cache.

Note that no I/O will be performed if blob_id or Self::set_head_commit has not been set to Some

Trait Implementations

impl From<GitIndex> for ComboIndexCache

fn from(gi: GitIndex) -> Self

Converts to this type from the input type.