Struct ValidCacheEntry

pub struct ValidCacheEntry<'buffer> {
    pub revision: &'buffer str,
    pub version_entries: &'buffer [u8],
}

A wrapper around a byte buffer that has been (partially) validated to be a valid cache entry

Fields

revision: &'buffer str

The cache entry’s revision

For git indices this will be the sha1 of the HEAD commit when the cache entry was written

For sparse indicies, this will be an HTTP header from the response that was last written to disk, which is currently either etag: <etag> or last-modified: <timestamp>

version_entries: &'buffer [u8]

Portion of the buffer containing the individual version entries for the cache entry

Implementations

impl<'buffer> ValidCacheEntry<'buffer>

pub fn read(buffer: &'buffer [u8]) -> Result<Self, CacheError>

Attempts to read a cache entry from a block of bytes.

This can fail for a few reasons

1. The cache version does not match the version(s) supported
2. The index version is higher than that supported
3. There is not at least 1 version entry

pub fn to_krate( &self, revision: Option<&str>, ) -> Result<Option<IndexKrate>, Error>

Deserializes this cache entry into a IndexKrate

If specified, the revision will be used to ignore cache entries that are outdated