Struct PlotSectorOptions

pub struct PlotSectorOptions<'a, RE, PG> {
    pub public_key: &'a PublicKey,
    pub sector_index: SectorIndex,
    pub piece_getter: &'a PG,
    pub farmer_protocol_info: FarmerProtocolInfo,
    pub kzg: &'a Kzg,
    pub erasure_coding: &'a ErasureCoding,
    pub pieces_in_sector: u16,
    pub sector_output: &'a mut Vec<u8>,
    pub downloading_semaphore: Option<Arc<Semaphore>>,
    pub encoding_semaphore: Option<&'a Semaphore>,
    pub records_encoder: &'a mut RE,
    pub abort_early: &'a AtomicBool,
}

Options for plotting a sector.

Sector output and sector metadata output should be either empty (in which case they’ll be resized to correct size automatically) or correctly sized from the beginning or else error will be returned.

Fields

public_key: &'a PublicKey

Public key corresponding to sector

sector_index: SectorIndex

Sector index

piece_getter: &'a PG

Getter for pieces of archival history

farmer_protocol_info: FarmerProtocolInfo

Farmer protocol info

kzg: &'a Kzg

KZG instance

erasure_coding: &'a ErasureCoding

Erasure coding instance

pieces_in_sector: u16

How many pieces should sector contain

sector_output: &'a mut Vec<u8>

Where plotted sector should be written, vector must either be empty (in which case it’ll be resized to correct size automatically) or correctly sized from the beginning

downloading_semaphore: Option<Arc<Semaphore>>

Semaphore for part of the plotting when farmer downloads new sector, allows to limit memory usage of the plotting process, permit will be held until the end of the plotting process

encoding_semaphore: Option<&'a Semaphore>

Semaphore for part of the plotting when farmer encodes downloaded sector, should typically allow one permit at a time for efficient CPU utilization

records_encoder: &'a mut RE

Proof of space table generators

abort_early: &'a AtomicBool

Whether encoding should be aborted early

Trait Implementations

impl<'a, RE: Debug, PG: Debug> Debug for PlotSectorOptions<'a, RE, PG>

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

Formats the value using the given formatter.