Struct BlobHeader 

pub struct BlobHeader { /* private fields */ }

Represents the header of a Blob, containing essential metadata about the blob’s structure and cryptographic commitments. This is essentially what is used during validity checking and repairing of erasure-coded chunks.

Implementations

impl BlobHeader

pub fn get_blob_size(&self) -> usize

Returns the original byte length of the blob data before padding.

pub fn get_num_chunksets(&self) -> usize

Returns the total number of chunksets that comprise the blob.

pub fn get_num_chunks(&self) -> usize

Returns the total number of erasure-coded chunks across all chunksets in the blob.

pub fn get_blob_digest(&self) -> Hash

Returns the BLAKE3 digest of the original, unpadded blob data.

pub fn get_root_commitment(&self) -> Hash

Returns the Merkle root commitment of the entire blob.

This commitment is derived from the Merkle tree of all chunksets in the blob.

pub fn get_chunkset_commitment( &self, chunkset_id: usize, ) -> Result<Hash, DecdsError>

Returns the Merkle root commitment of a specific chunkset within the blob.

Arguments

• chunkset_id - The ID of the chunkset whose commitment is to be retrieved.

Returns

Returns a Result which is:

• Ok(blake3::Hash) containing the root commitment of the specified chunkset if successful.
• Err(DecdsError::InvalidChunksetId) if chunkset_id is out of bounds.

pub fn get_chunkset_size(&self, chunkset_id: usize) -> Result<usize, DecdsError>

Calculates the effective byte length of a specific chunkset within the blob. This accounts for the last chunkset potentially being smaller than ChunkSet::BYTE_LENGTH.

Arguments

• chunkset_id - The ID of the chunkset whose size is to be determined.

Returns

Returns a Result which is:

• Ok(usize) containing the effective byte length of the chunkset if successful.
• Err(DecdsError::InvalidChunksetId) if chunkset_id is out of bounds.

pub fn get_byte_range_for_chunkset( &self, chunkset_id: usize, ) -> Result<(usize, usize), DecdsError>

Returns the full byte range [start, end) of a specific chunkset as it would appear in the zero-padded blob data.

Arguments

• chunkset_id - The ID of the chunkset whose byte range is to be retrieved.

Returns

Returns a Result which is:

• Ok((usize, usize)) containing a tuple [start_byte_idx, end_byte_idx) if successful.
• Err(DecdsError::InvalidChunksetId) if chunkset_id is out of bounds.

pub fn get_chunkset_ids_for_byte_range( &self, byte_range: impl RangeBounds<usize>, ) -> Result<Vec<usize>, DecdsError>

Determines the IDs of all chunksets that overlap with a given byte range within the blob.

Arguments

• byte_range - A range impl RangeBounds<usize> specifying the byte range.

Returns

Returns a Result which is:

• Ok(Vec<usize>) containing a vector of chunkset IDs if successful.
• Err(DecdsError::InvalidStartBound) if the start bound of the range is not valid.
• Err(DecdsError::InvalidEndBound) if the end bound of the range is not valid (e.g., 0 for an Excluded bound or usize::MAX).
• Err(DecdsError::InvalidChunksetId) if the calculated end_chunkset_id is out of bounds.

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

Serializes the BlobHeader into a vector of bytes using bincode.

Returns

Returns a Result which is:

• Ok(Vec<u8>) containing the serialized bytes if successful.
• Err(DecdsError::BlobHeaderSerializationFailed) if bincode serialization fails.

pub fn from_bytes(bytes: &[u8]) -> Result<(Self, usize), DecdsError>

Deserializes a BlobHeader from a byte slice using bincode.

Arguments

• bytes - The byte slice from which to deserialize the header.

Returns

Returns a Result which is:

• Ok((Self, usize)) containing the deserialized BlobHeader and the number of bytes read if successful.
• Err(DecdsError::BlobHeaderDeserializationFailed) if bincode deserialization fails, or if the number of chunksets in the header does not match the number of root commitments.

pub fn validate_chunk(&self, chunk: &ProofCarryingChunk) -> bool

Validates a ProofCarryingChunk against the BlobHeader’s commitments.

This checks if the chunk is correctly included in the blob (via blob root commitment) and its respective chunkset (via chunkset root commitment).

Arguments

• chunk - A reference to the ProofCarryingChunk to validate.

Returns

Returns true if the chunk is valid and its proofs are consistent with the blob header, false otherwise.

Trait Implementations

impl Clone for BlobHeader

fn clone(&self) -> BlobHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlobHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlobHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BlobHeader

fn eq(&self, other: &BlobHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BlobHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BlobHeader