Struct RepairingChunkSet 

pub struct RepairingChunkSet { /* private fields */ }

A structure designed to help incrementally reconstruct the original data of a ChunkSet by collecting enough erasure-coded chunks, verifying their integrity, and performing RLNC decoding.

Implementations

impl RepairingChunkSet

pub fn new(chunkset_id: usize, commitment: Hash) -> Self

Creates a new RepairingChunkSet instance.

Arguments

• chunkset_id - The ID of the chunkset being repaired.
• commitment - The expected Merkle root commitment of the chunkset, used for validating chunk inclusion in chunkset.

Returns

A new RepairingChunkSet instance.

pub fn add_chunk( &mut self, chunk: &ProofCarryingChunk, ) -> Result<(), DecdsError>

Adds a ProofCarryingChunk to the RepairingChunkSet after validating its Merkle proof. The chunk’s inclusion proof in this chunkset is verified against the commitment stored in RepairingChunkSet.

Arguments

• chunk - The ProofCarryingChunk to add.

Returns

Returns a Result which is:

• Ok(()) if the chunk is successfully added and validated.
• Err(DecdsError::InvalidProofInChunk) if the chunk’s inclusion proof is invalid for this chunkset.
• Err(DecdsError::InvalidChunkMetadata) if the chunk’s chunkset_id does not match this RepairingChunkSet.
• Err(DecdsError::ChunkDecodingFailed) if the underlying RLNC decoding operation fails.

pub fn add_chunk_unvalidated( &mut self, chunk: &ProofCarryingChunk, ) -> Result<(), DecdsError>

Adds a ProofCarryingChunk to the RepairingChunkSet without validating its Merkle proof. This method is intended for use when proof validation has already occurred.

Arguments

• chunk - The ProofCarryingChunk to add.

Returns

Returns a Result which is:

• Ok(()) if the chunk is successfully added.
• Err(DecdsError::InvalidChunkMetadata) if the chunk’s chunkset_id does not match this RepairingChunkSet.
• Err(DecdsError::ChunksetReadyToRepair) if the chunkset is ready to repair, no more chunks are required. Just call repair.
• Err(DecdsError::ChunkDecodingFailed) if the underlying RLNC decoding operation fails.

pub fn is_ready_to_repair(&self) -> bool

Checks if enough useful erasure-coded chunks have been collected to repair the original data for this chunkset.

pub fn repair(self) -> Result<Vec<u8>, DecdsError>

Repairs the original data of the chunkset if enough chunks have been collected. This consumes the RepairingChunkSet as the decoding process is final.

Returns

Returns a Result which is:

• Ok(Vec<u8>) containing the repaired original data if successful.
• Err(DecdsError::ChunksetNotYetReadyToRepair) if not enough chunks have been added yet.
• Err(DecdsError::ChunksetRepairingFailed) if an error occurs during the RLNC decoding process.