Struct celestia_types::sample::SampleId

pub struct SampleId { /* private fields */ }

Identifies a particular Share located in the ExtendedDataSquare.

Implementations

impl SampleId

pub fn new(row_index: u16, column_index: u16, block_height: u64) -> Result<Self>

Create a new SampleId for the given row_index and column_index of the ExtendedDataSquare in a block.

Errors

This function will return an error if the block height is zero.

Example

use celestia_types::sample::SampleId;

// Consider an 64 share EDS with block height of 15
let header_height = 15;

SampleId::new(2, 1, header_height).unwrap();

pub fn block_height(&self) -> u64

A height of the block which contains the sample.

pub fn row_index(&self) -> u16

Row index of the ExtendedDataSquare that sample is located on.

pub fn column_index(&self) -> u16

Column index of the ExtendedDataSquare that sample is located on.

Trait Implementations

impl Clone for SampleId

fn clone(&self) -> SampleId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleId

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

Formats the value using the given formatter.

impl From<SampleId> for CidGeneric<SAMPLE_ID_SIZE>

fn from(sample_id: SampleId) -> Self

Converts to this type from the input type.

impl PartialEq for SampleId

fn eq(&self, other: &SampleId) -> 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<const S: usize> TryFrom<Cid<S>> for SampleId

type Error = CidError

The type returned in the event of a conversion error.

fn try_from(cid: CidGeneric<S>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SampleId

impl StructuralPartialEq for SampleId