Struct Record

pub struct Record(/* private fields */);

Record contained within a piece.

NOTE: This is a stack-allocated data structure and can cause stack overflow!

Implementations

impl Record

pub const NUM_CHUNKS: usize = 32_768usize

Number of chunks (scalars) within one record.

pub const NUM_S_BUCKETS: usize = 65_536usize

Number of s-buckets contained within one record (and by extension sector).

Essentially we chunk records into scalars and erasure code them.

pub const SIZE: usize = 1_048_576usize

Size of a segment record given the global piece size (in bytes) after erasure coding RawRecord, is guaranteed to be a multiple of ScalarBytes::FULL_BYTES.

pub fn new_boxed() -> Box<Self>

Create boxed value without hitting stack overflow

pub fn new_zero_vec(length: usize) -> Vec<Self>

Create vector filled with zeroe records without hitting stack overflow

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

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

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

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

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

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

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

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

pub fn to_raw_record_chunks( &self, ) -> impl DoubleEndedIterator<Item = &[u8; 31]> + '_

Convert from a record to its raw bytes, assumes dealing with source record that only stores safe bytes in its chunks.

pub fn to_mut_raw_record_chunks( &mut self, ) -> impl DoubleEndedIterator<Item = &mut [u8; 31]> + '_

Convert from a record to mutable raw bytes, assumes dealing with source record that only stores safe bytes in its chunks.

Trait Implementations

impl AsMut<[u8]> for Record

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

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

impl AsRef<[u8]> for Record

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

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

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Default for Record

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Record

type Target = [[u8; 32]; 32768]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Record

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

Mutably dereferences the value.

impl From<&[[u8; 32]; 32768]> for &Record

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

Converts to this type from the input type.

impl From<&[u8; 1048576]> for &Record

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

Converts to this type from the input type.

impl From<&Record> for &[[u8; 32]; 32768]

fn from(value: &Record) -> Self

Converts to this type from the input type.

impl From<&Record> for &[u8; 1048576]

fn from(value: &Record) -> Self

Converts to this type from the input type.

impl From<&mut [[u8; 32]; 32768]> for &mut Record

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

Converts to this type from the input type.

impl From<&mut [u8; 1048576]> for &mut Record

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

Converts to this type from the input type.

impl From<&mut Record> for &mut [[u8; 32]; 32768]

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

Converts to this type from the input type.

impl From<&mut Record> for &mut [u8; 1048576]

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

Converts to this type from the input type.

impl PartialEq for Record

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

impl Eq for Record

impl StructuralPartialEq for Record