Struct git_chunk::file::Index

pub struct Index {
    pub chunks: Vec<Entry>,
}

A chunk file providing a table into the parent data.

Fields

chunks: Vec<Entry>

Validated chunks as defined by their index entries.

Note that this list cannot be empty.

Implementations

impl Index

pub fn from_bytes(
    data: &[u8],
    toc_offset: usize,
    num_chunks: u32
) -> Result<Self, Error>

Provided a mapped file at the beginning via data, starting at toc_offset decode all chunk information to return an index with num_chunks chunks.

impl Index

pub const ENTRY_SIZE: usize

The size of a single index entry in bytes

pub const EMPTY_SIZE: usize

The smallest possible size of an index, consisting only of the sentinel value pointing past itself.

pub fn offset_by_kind(&self, kind: Kind) -> Result<Range<Offset>, Error>

Find a chunk of kind and return its offset into the data if found

pub fn data_by_kind<'a>(
    &self,
    data: &'a [u8],
    kind: Kind
) -> Result<&'a [u8], Error>

Find a chunk of kind and return its data slice based on its offset.

pub fn highest_offset(&self) -> Offset

Return the end offset lf the last chunk, which is the highest offset as well. It’s definitely available as we have one or more chunks.