Struct CodedBlock 

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

An envelope type for an erasure coded Block.

Implementations

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

pub fn new(inner: B, config: CodingConfig, strategy: &impl Strategy) -> Self

Create a new CodedBlock from a Block and a configuration.

pub fn new_trusted(inner: B, commitment: Commitment) -> Self

Create a new CodedBlock from a Block and trusted Commitment.

pub const fn config(&self) -> CodingConfig

Returns the coding configuration for the data committed.

pub fn shards(&mut 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<C, H>>

where B: CertifiableBlock,

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 into_inner(self) -> B

Takes the inner Block.

Trait Implementations

impl<B: CertifiableBlock, 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: CertifiableBlock, C: Scheme, H: Hasher> Committable for CodedBlock<B, C, H>

type Commitment = Commitment

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::Commitment: Debug, 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.

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 working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl<B: CertifiableBlock + Clone, 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

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<B: Block, C: Scheme, H: Hasher> Read for CodedBlock<B, C, H>

type Cfg = CodedBlockCfg<B>

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

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 Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.

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