Struct git_odb::pack::data::File

[+] Show declaration

pub struct File { /* fields omitted */ }

Implementations

impl File[−]

[−] Expand description

Reading of objects

pub fn decompress_entry(
    &self,
    entry: &Entry,
    out: &mut [u8]
) -> Result<usize, Error>

pub fn entry(&self, offset: u64) -> Entry

pub fn decode_entry(
    &self,
    entry: Entry,
    out: &mut Vec<u8>,
    resolve: impl Fn(Id, &mut Vec<u8>) -> Option<ResolvedBase>,
    delta_cache: &mut impl DecodeEntry
) -> Result<Outcome, Error>[−]

Decode an entry, resolving delta's as needed, while growing the output vector if there is not enough space to hold the result object. Returns (object_kind, compressed_size), referring to the entry in-pack size for use with CRC32 checks such as in crc32(pack_data[entry.data_offset..entry.data_offset + compressed_size])

impl File[−]

[−] Expand description

Instantiation

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

impl File[−]

[−] Expand description

Checksums and verify checksums

pub fn checksum(&self) -> Id

pub fn verify_checksum(&self, progress: impl Progress) -> Result<Id, Error>

impl File[−]

pub fn streaming_iter(&self) -> Result<Iter<impl BufRead>, Error>[−]

Returns an iterator over the pack file itself, without making use of the memory mapping.

Note that this iterator is costly as no pack index is used, forcing each entry to be decompressed. If an index is available, use the traverse(…) method instead for maximum performance.

impl File[−]

pub const HEADER_LEN: usize

pub fn kind(&self) -> Kind

pub fn num_objects(&self) -> u32

pub fn data_len(&self) -> usize[−]

The length of all mapped data, including the pack header and the pack trailer

pub fn pack_end(&self) -> usize[−]

The position of the byte one past the last entry, or in other terms, the first byte of the trailing hash.

pub fn path(&self) -> &Path

pub fn entry_slice(&self, slice: EntrySlice) -> Option<&[u8]>

pub fn entry_crc32(&self, pack_offset: u64, size: usize) -> u32[−]

Currently only done during pack verification - finding the right size is only possible by decompressing the pack entry beforehand, or by using the (to be sorted) offsets stored in an index file.

Trait Implementations

impl<'_> TryFrom<&'_ Path> for File[+]

[+] Show hidden undocumented items

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.