Struct Share

pub struct Share { /* private fields */ }

A single fixed-size chunk of data which is used to form an ExtendedDataSquare.

All data in Celestia is split into Shares before being put into a block’s data square. See Blob::to_shares.

All shares have the fixed size of 512 bytes and the following structure:

| Namespace | InfoByte | (optional) sequence length | data |

sequence length is the length of the original data in bytes and is present only in the first of the shares the data was split into.

Implementations

impl Share

pub fn from_raw(data: &[u8]) -> Result<Self>

Create a new Share from raw bytes.

Errors

This function will return an error if the slice length isn’t SHARE_SIZE or if a namespace encoded in the share is invalid.

Example

use celestia_types::Share;

let raw = [0; 512];
let share = Share::from_raw(&raw).unwrap();

pub fn parity(data: &[u8]) -> Result<Share>

Create a new Share within Namespace::PARITY_SHARE from raw bytes.

Errors

This function will return an error if the slice length isn’t SHARE_SIZE.

pub fn validate(&self, app: AppVersion) -> Result<()>

Check if share is valid in given AppVersion

pub fn is_parity(&self) -> bool

Returns true if share contains parity data.

pub fn namespace(&self) -> Namespace

Get the Namespace the Share belongs to.

pub fn info_byte(&self) -> Option<InfoByte>

Return Share’s InfoByte

Returns None if share is within Namespace::PARITY_SHARE.

pub fn sequence_length(&self) -> Option<u32>

For first share in a sequence, return sequence length, None for continuation shares

pub fn signer(&self) -> Option<AccAddress>

Get the signer part of share if it’s first in the sequence of sparse shares and share_version supprots it. Otherwise returns None

pub fn payload(&self) -> Option<&[u8]>

Get the payload of the share.

Payload is the data that shares contain after all its metadata, e.g. blob data in sparse shares.

Returns None if share is within Namespace::PARITY_SHARE.

pub fn data(&self) -> &[u8; 512]

Get the underlying share data.

pub fn to_vec(&self) -> Vec<u8>

Converts this Share into the raw bytes vector.

This will include also the InfoByte and the sequence length.

Trait Implementations

impl AsMut<[u8]> for Share

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Share

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Block<NMT_ID_SIZE> for Share

fn cid(&self) -> Result<CidGeneric<NMT_ID_SIZE>, CidError>

Get the CID of the block.

fn data(&self) -> &[u8]

Get the data of the block.

impl Clone for Share

fn clone(&self) -> Share

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Share

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Share

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Share> for RawShare

fn from(value: Share) -> Self

Converts to this type from the input type.

impl PartialEq for Share

fn eq(&self, other: &Share) -> 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 Share

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Share> for Share

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: RawShare) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Share

impl StructuralPartialEq for Share