Struct PieceArray

#[repr(C)]
pub struct PieceArray(/* private fields */);

A piece of archival history.

This version is allocated on the stack, for heap-allocated piece see Piece.

Internally a piece contains a record, followed by record root, supplementary record chunk root and a proof proving this piece belongs to can be used to verify that a piece belongs to the actual archival history of the blockchain.

Implementations

impl PieceArray

pub const SIZE: usize = 1_048_896usize

Size of a piece (in bytes).

pub fn new_boxed() -> Box<Self>

Create boxed value without hitting stack overflow

pub fn is_valid(&self, segment_root: &SegmentRoot, position: u32) -> bool

Validate proof embedded within a piece produced by the archiver

pub fn split(&self) -> (&Record, &RecordRoot, &RecordChunksRoot, &RecordProof)

Split piece into underlying components.

pub fn split_mut( &mut self, ) -> (&mut Record, &mut RecordRoot, &mut RecordChunksRoot, &mut RecordProof)

Split piece into underlying mutable components.

pub fn record(&self) -> &Record

Record contained within a piece.

pub fn record_mut(&mut self) -> &mut Record

Mutable record contained within a piece.

pub fn root(&self) -> &RecordRoot

Root contained within a piece.

pub fn root_mut(&mut self) -> &mut RecordRoot

Mutable root contained within a piece.

pub fn parity_chunks_root(&self) -> &RecordChunksRoot

Parity chunks root contained within a piece.

pub fn parity_chunks_root_mut(&mut self) -> &mut RecordChunksRoot

Mutable parity chunks root contained within a piece.

pub fn proof(&self) -> &RecordProof

Proof contained within a piece.

pub fn proof_mut(&mut self) -> &mut RecordProof

Mutable proof contained within a piece.

pub fn slice_to_repr(value: &[Self]) -> &[[u8; 1048896]]

Convenient conversion from slice of piece array to underlying representation for efficiency purposes.

pub fn slice_from_repr(value: &[[u8; 1048896]]) -> &[Self]

Convenient conversion from slice of underlying representation to piece array for efficiency purposes.

pub fn slice_mut_to_repr(value: &mut [Self]) -> &mut [[u8; 1048896]]

Convenient conversion from mutable slice of piece array to underlying representation for efficiency purposes.

pub fn slice_mut_from_repr(value: &mut [[u8; 1048896]]) -> &mut [Self]

Convenient conversion from mutable slice of underlying representation to piece array for efficiency purposes.

Trait Implementations

impl AsMut<[u8]> for PieceArray

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

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

impl AsMut<[u8; 1048896]> for PieceArray

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

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

impl AsRef<[u8]> for PieceArray

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

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

impl AsRef<[u8; 1048896]> for PieceArray

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

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

impl Clone for PieceArray

fn clone(&self) -> PieceArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PieceArray

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

Formats the value using the given formatter.

impl Default for PieceArray

fn default() -> Self

Returns the “default value” for a type.

impl Deref for PieceArray

type Target = [u8; 1048896]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for PieceArray

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<&[u8; 1048896]> for &PieceArray

fn from(value: &[u8; 1048896]) -> Self

Converts to this type from the input type.

impl From<&PieceArray> for &[u8; 1048896]

fn from(value: &PieceArray) -> Self

Converts to this type from the input type.

impl From<&PieceArray> for Piece

fn from(value: &PieceArray) -> Self

Converts to this type from the input type.

impl From<&mut [u8; 1048896]> for &mut PieceArray

fn from(value: &mut [u8; 1048896]) -> Self

Converts to this type from the input type.

impl From<&mut PieceArray> for &mut [u8; 1048896]

fn from(value: &mut PieceArray) -> Self

Converts to this type from the input type.

impl Hash for PieceArray

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PieceArray

fn cmp(&self, other: &PieceArray) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PieceArray

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

fn partial_cmp(&self, other: &PieceArray) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PieceArray

impl Eq for PieceArray

impl StructuralPartialEq for PieceArray