Struct CodedBlock 

pub struct CodedBlock<B: Block, C: Scheme, H: Hasher> { /* private fields */ }

An envelope type for an erasure coded Block.

The consensus commitment is fixed when the block is built, decoded, or restored, so reading the commitment or the inner block’s digest never hashes or erasure codes.

Implementations

impl<B: Block, C: Scheme, H: Hasher> CodedBlock<B, C, H>

pub const fn max_encode_size(application: usize) -> usize

Returns the largest encoded size of a coded block whose application block encodes to at most application bytes.

pub fn precomputed(inner: Digested<B>, commitment: Commitment<B, C, H>) -> Self

Creates a CodedBlock from a Block and its precomputed Commitment.

commitment must encode inner. Self::shards generates shards on demand and panics if the coding root does not match.

Panics if commitment does not commit to the block’s digest.

pub fn config(&self) -> CodingConfig

Returns the coding configuration for the data committed.

pub fn shards(&self, strategy: &impl Strategy) -> &[C::Shard]

Returns a reference to the shards in this coded block.

If the shards have not yet been generated, they will be created via Scheme::encode.

pub fn shard(&self, index: u16) -> Option<Shard<B, C, H>>

Returns a Shard at the given index, if the index is valid.

pub fn inner(&self) -> &B

Returns a reference to the inner Block.

pub fn inner_shared(&self) -> Arc<B>

Returns a shared reference to the inner Block.

pub fn inner_digested(&self) -> Digested<B>

Returns the inner Block with its digest, which the commitment binds.

impl<B: CertifiableBlock, C: Scheme, H: Hasher> CodedBlock<B, C, H>

pub fn encode( inner: Digested<B>, config: CodingConfig, strategy: &impl Strategy, ) -> impl Future<Output = Self> + Send + 'static

Erasure codes inner with config as a job on strategy, producing a CodedBlock that holds its shards.

Trait Implementations

impl<B: Block, C: Scheme, H: Hasher> Block for CodedBlock<B, C, H>

fn parent(&self) -> Self::Digest

Get the parent block’s digest.

impl<B: CertifiableBlock, C: Scheme, H: Hasher> CertifiableBlock for CodedBlock<B, C, H>

type Context = <B as CertifiableBlock>::Context

The consensus context type stored in this block.

fn context(&self) -> Self::Context

Get the consensus context that was used when this block was proposed.

impl<B: Block, C: Scheme, H: Hasher> Clone for CodedBlock<B, C, H>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Block, C: Scheme, H: Hasher> Committable for CodedBlock<B, C, H>

type Commitment = Commitment<B, C, H>

The type of commitment produced by this object.

fn commitment(&self) -> Self::Commitment

Returns the unique commitment of the object as a Digest.

impl<B: Debug + Block, C: Debug + Scheme, H: Debug + Hasher> Debug for CodedBlock<B, C, H>

where C::Shard: Debug,

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

Formats the value using the given formatter.

impl<B: Block, C: Scheme, H: Hasher> Digestible for CodedBlock<B, C, H>

type Digest = <B as Digestible>::Digest

The type of digest produced by this object.

fn digest(&self) -> Self::Digest

Returns a unique representation of the object as a Digest.

fn digest_across(&self, _strategy: &impl Strategy) -> Self::Digest

Returns the object’s digest, splitting any work in computing it across strategy.

impl<B: Block, C: Scheme, H: Hasher> EncodeSize for CodedBlock<B, C, H>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the fixed working buffer for inline writes, so it must not be less than the bytes written inline. Override alongside Write::write_bufs for types where large byte fields go via push, or the working buffer will over-allocate.

impl<B: Block + Eq, C: Scheme, H: Hasher> Eq for CodedBlock<B, C, H>

impl<B: Block, C: Scheme, H: Hasher> From<CodedBlock<B, C, H>> for StoredCodedBlock<B, C, H>

fn from(block: CodedBlock<B, C, H>) -> Self

Converts to this type from the input type.

impl<B: Block, C: Scheme, H: Hasher> From<StoredCodedBlock<B, C, H>> for CodedBlock<B, C, H>

Converts a StoredCodedBlock back to a CodedBlock.

fn from(stored: StoredCodedBlock<B, C, H>) -> Self

Converts to this type from the input type.

impl<B: Block, C: Scheme, H: Hasher> Heightable for CodedBlock<B, C, H>

fn height(&self) -> Height

Returns the height associated with this object.

impl<B: Block + PartialEq, C: Scheme, H: Hasher> PartialEq for CodedBlock<B, C, H>

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

Equality operator ==.

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

Inequality operator !=.

impl<B: Block, C: Scheme, H: Hasher> Write for CodedBlock<B, C, H>

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing byte chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.