Struct subspace_farmer_components::sector::SectorContentsMap

pub struct SectorContentsMap { /* private fields */ }

Abstraction on top of bitfields that allow making sense of sector contents that contains both encoded (meaning erasure coded and encoded with existing PoSpace quality) and unencoded chunks (just erasure coded) used at the same time both in records (before writing to plot) and s-buckets (written into the plot) format

Implementations

impl SectorContentsMap

pub fn new(pieces_in_sector: u16) -> Self

Create new sector contents map initialized with zeroes to store data for pieces_in_sector records

pub fn from_bytes( bytes: &[u8], pieces_in_sector: u16, ) -> Result<Self, SectorContentsMapFromBytesError>

Reconstruct sector contents map from bytes.

Returns error if length of the vector doesn’t match Self::encoded_size() for pieces_in_sector.

pub const fn encoded_size(pieces_in_sector: u16) -> usize

Size of sector contents map when encoded and stored in the plot for specified number of pieces in sector

pub fn encode_into( &self, output: &mut [u8], ) -> Result<(), SectorContentsMapEncodeIntoError>

Encode internal contents into output

pub fn num_encoded_record_chunks(&self) -> &[SBucket]

Number of encoded chunks in each record

pub fn iter_record_bitfields(&self) -> &[BitArray<[u8; 8192]>]

Iterate over individual record bitfields

pub fn iter_record_bitfields_mut( &mut self, ) -> impl ExactSizeIterator<Item = EncodedChunksUsed<'_>> + '_

Iterate mutably over individual record bitfields

pub fn s_bucket_sizes(&self) -> Box<[u16; 65536]>

Returns sizes of each s-bucket

pub fn iter_record_chunk_to_plot( &self, piece_offset: PieceOffset, ) -> impl Iterator<Item = (SBucket, bool, usize)> + '_

Creates an iterator of (s_bucket, encoded_chunk_used, chunk_location), where s_bucket is position of the chunk in the erasure coded record, encoded_chunk_used indicates whether it was encoded and chunk_location is the offset of the chunk in the plot (across all s-buckets).

pub fn par_iter_record_chunk_to_plot( &self, piece_offset: PieceOffset, ) -> impl IndexedParallelIterator<Item = Option<(usize, bool)>> + '_

Creates an iterator of Option<(chunk_offset, encoded_chunk_used)>, where each entry corresponds s-bucket/position of the chunk in the erasure coded record, encoded_chunk_used indicates whether it was encoded and chunk_offset is the offset of the chunk in the corresponding s-bucket.

Similar to Self::iter_record_chunk_to_plot(), but runs in parallel, returns entries for all s-buckets and offsets are within corresponding s-buckets rather than the whole plot.

pub fn iter_s_bucket_records( &self, s_bucket: SBucket, ) -> Result<impl Iterator<Item = (PieceOffset, bool)> + '_, SectorContentsMapIterationError>

Creates an iterator of (piece_offset, encoded_chunk_used), where piece_offset corresponds to the record to which chunk belongs and encoded_chunk_used indicates whether it was encoded.

Returns error if s_bucket is outside of [Record::NUM_S_BUCKETS] range.

pub fn iter_s_bucket_encoded_record_chunks_used( &self, s_bucket: SBucket, ) -> Result<impl Iterator<Item = bool> + '_, SectorContentsMapIterationError>

Iterate over chunks of s-bucket indicating if encoded chunk is used at corresponding position

Panics

Panics if s_bucket is outside of [Record::NUM_S_BUCKETS] range.

Trait Implementations

impl Clone for SectorContentsMap

fn clone(&self) -> SectorContentsMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SectorContentsMap

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

Formats the value using the given formatter.

impl PartialEq for SectorContentsMap

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

impl StructuralPartialEq for SectorContentsMap