Struct celestia_types::Share

pub struct Share {
    pub data: [u8; 512],
}

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.

Fields

data: [u8; 512]

A raw data of the share.

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 namespace(&self) -> Namespace

Get the Namespace the Share belongs to.

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

Get all the data that follows the Namespace of the Share.

This will include also the InfoByte and the sequence length.

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.

pub fn info_byte(&self) -> InfoByte

Return Share’s InfoByte

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

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

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 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 Eq for Share

impl StructuralPartialEq for Share