Struct bitar::ChunkIndex

pub struct ChunkIndex(_);

Index of chunks for a file.

Allows us to map between chunk hashes and source content location.

Implementations

impl ChunkIndex

pub fn new_empty() -> Self

Create an empty chunk index.

pub fn add_chunk(&mut self, hash: HashSum, size: usize, offsets: &[u64])

Add a chunk with size and offsets to the index.

pub fn remove(&mut self, hash: &HashSum) -> Option<ChunkLocation>

Remove a chunk by hash.

pub fn contains(&self, hash: &HashSum) -> bool

Test if a chunk is in the index.

pub fn len(&self) -> usize

Get number of chunks in the index.

pub fn is_empty(&self) -> bool

Test if index is empty.

pub fn offsets<'a>(
    &'a self,
    hash: &HashSum
) -> Option<impl Iterator<Item = u64> + 'a>

Iterate source offsets of a chunk.

pub fn keys(&self) -> impl Iterator<Item = &HashSum>

Iterate chunk hashes in index.

pub fn strip_chunks_already_in_place(
    &self,
    chunk_set: &mut ChunkIndex
) -> (usize, u64)

Filter the given chunk index for chunks which are already in place in self

Returns the number of chunks filtered and total size of them.

pub fn reorder_ops(&self, new_order: &ChunkIndex) -> Vec<ReorderOp>

Get a description of how to transform one source file into another.

The transformation is done by reordering the chunks of a file in place trying to match the new order. Only the chunks present in both the current index and the new index will be reordered, while chunks that are not present in the current index still has to be fetched from elsewhere.

pub fn iter_chunks(&self) -> impl Iterator<Item = (&HashSum, &ChunkLocation)>

Iterate all chunks in the index.

Chunks are returned in undefined order.

Trait Implementations

impl Clone for ChunkIndex

fn clone(&self) -> ChunkIndex

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChunkIndex

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.