Struct git_odb::pack::index::File

pub struct File { /* fields omitted */ }

Implementations

impl File

pub fn kind(&self) -> Kind

pub fn num_objects(&self) -> u32

pub fn version(&self) -> u32

pub fn iter_v1<'a>(&'a self) -> impl Iterator<Item = Entry> + 'a

pub fn iter_v2<'a>(&'a self) -> impl Iterator<Item = Entry> + 'a

pub fn oid_at_index(&self, index: u32) -> &[u8]

Returns 20 bytes sha1 at the given index in our list of (sorted) sha1 hashes. The index ranges from 0 to self.num_objects()

pub fn pack_offset_at_index(&self, index: u32) -> u64

pub fn crc32_at_index(&self, index: u32) -> Option<u32>

pub fn lookup_index(&self, id: &[u8]) -> Option<u32>

Returns the offset of the given object ID (20 bytes) for use with the (oid|pack_offset|crc32)_at_index()

pub fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = Entry> + 'a>

pub fn at(path: impl AsRef<Path>) -> Result<File, Error>

impl File

Methods to verify and validate the content of the index file

pub fn checksum_of_index(&self) -> Id

pub fn checksum_of_pack(&self) -> Id

pub fn verify_checksum_of_index<P, C>(
    &self,
    pack: Option<&File>,
    progress: Option<P>,
    make_cache: impl Fn() -> C + Send + Sync
) -> Result<(Id, Option<PackFileChecksumResult>), ChecksumError> where
    P: Progress,
    <P as Progress>::SubProgress: Send,
    C: DecodeEntry, 

If pack is provided, it is expected (and validated to be) the pack belonging to this index. It will be used to validate internal integrity of the pack before checking each objects integrity is indeed as advertised via its SHA1 as stored in this index, as well as the CRC32 hash.

Trait Implementations

impl<'_> TryFrom<&'_ Path> for File

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>

Performs the conversion.