Struct Shard 

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

A broadcastable shard of erasure coded data, including the coding commitment and the configuration used to code the data.

Implementations

impl<C: Scheme, H: Hasher> Shard<C, H>

pub const fn new( commitment: Commitment, index: u16, inner: DistributionShard<C>, ) -> Self

pub const fn index(&self) -> u16

Returns the index of this shard within the commitment.

pub const fn commitment(&self) -> Commitment

Returns the Commitment for this shard.

pub const fn is_strong(&self) -> bool

Returns true if the inner shard is strong.

pub const fn is_weak(&self) -> bool

Returns true if the inner shard is weak.

pub fn into_inner(self) -> DistributionShard<C>

Takes the inner DistributionShard.

pub fn verify_into_weak(self) -> Option<Self>

Verifies the shard and returns the weak shard for broadcasting if valid.

Returns Some(weak_shard) if the shard is valid and can be rebroadcast, or None if the shard is invalid or already weak.

Trait Implementations

impl<C: Scheme, H: Hasher> Clone for Shard<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<C: Scheme, H: Hasher> Committable for Shard<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<C: Scheme, H: Hasher> Deref for Shard<C, H>

type Target = DistributionShard<C>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<C: Scheme, H: Hasher> EncodeSize for Shard<C, H>

fn encode_size(&self) -> usize

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

impl<C: Scheme, H: Hasher> PartialEq for Shard<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<C: Scheme, H: Hasher> Read for Shard<C, H>

type Cfg = CodecConfig

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<C: Scheme, H: Hasher> Write for Shard<C, H>

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

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

impl<C: Scheme, H: Hasher> Eq for Shard<C, H>