Struct SingleDiskFarm 

pub struct SingleDiskFarm { /* private fields */ }

Single disk farm abstraction is a container for everything necessary to plot/farm with a single disk.

Farm starts operating during creation and doesn’t stop until dropped (or error happens).

Implementations

impl SingleDiskFarm

pub const PLOT_FILE: &'static str = "plot.bin"

Name of the plot file

pub const METADATA_FILE: &'static str = "metadata.bin"

Name of the metadata file

pub async fn new<NC, PosTable>( options: SingleDiskFarmOptions<'_, NC>, farm_index: usize, ) -> Result<Self, SingleDiskFarmError>

where NC: NodeClient + Clone, PosTable: Table,

Create new single disk farm instance

pub fn collect_summary(directory: PathBuf) -> SingleDiskFarmSummary

Collect summary of single disk farm for presentational purposes

pub fn effective_disk_usage( directory: &Path, cache_percentage: u8, ) -> Result<u64, SingleDiskFarmError>

Effective on-disk allocation of the files related to the farm (takes some buffer space into consideration).

This is a helpful number in case some files were not allocated properly or were removed and do not correspond to allocated space in the farm info accurately.

pub fn read_all_sectors_metadata( directory: &Path, ) -> Result<Vec<SectorMetadataChecksummed>>

Read all sectors metadata

pub fn id(&self) -> &FarmId

ID of this farm

pub fn info(&self) -> &SingleDiskFarmInfo

Info of this farm

pub fn total_sectors_count(&self) -> u16

Number of sectors in this farm

pub fn plotted_sectors(&self) -> SingleDiskPlottedSectors

Read information about sectors plotted so far

pub fn piece_cache(&self) -> SingleDiskPieceCache

Get piece cache instance

pub fn plot_cache(&self) -> DiskPlotCache

Get plot cache instance

pub fn piece_reader(&self) -> DiskPieceReader

Get piece reader to read plotted pieces later

pub fn on_sector_update( &self, callback: HandlerFn<(SectorIndex, SectorUpdate)>, ) -> HandlerId

Subscribe to sector updates

pub fn on_farming_notification( &self, callback: HandlerFn<FarmingNotification>, ) -> HandlerId

Subscribe to farming notifications

pub fn on_solution(&self, callback: HandlerFn<SolutionResponse>) -> HandlerId

Subscribe to new solution notification

pub async fn run(self) -> Result<()>

Run and wait for background threads to exit or return an error

pub fn wipe(directory: &Path) -> Result<()>

Wipe everything that belongs to this single disk farm

pub fn scrub( directory: &Path, disable_farm_locking: bool, target: ScrubTarget, dry_run: bool, ) -> Result<(), SingleDiskFarmScrubError>

Check the farm for corruption and repair errors (caused by disk errors or something else), returns an error when irrecoverable errors occur.

Trait Implementations

impl Debug for SingleDiskFarm

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

Formats the value using the given formatter.

impl Drop for SingleDiskFarm

fn drop(&mut self)

Executes the destructor for this type.

impl Farm for SingleDiskFarm

fn id(&self) -> &FarmId

ID of this farm

fn total_sectors_count(&self) -> u16

Number of sectors in this farm

fn plotted_sectors(&self) -> Arc<dyn PlottedSectors + 'static>

Get plotted sectors instance

fn piece_reader(&self) -> Arc<dyn PieceReader + 'static>

Get piece reader to read plotted pieces later

fn on_sector_update( &self, callback: HandlerFn<(SectorIndex, SectorUpdate)>, ) -> Box<dyn HandlerId>

Subscribe to sector updates

fn on_farming_notification( &self, callback: HandlerFn<FarmingNotification>, ) -> Box<dyn HandlerId>

Subscribe to farming notifications

fn on_solution( &self, callback: HandlerFn<SolutionResponse>, ) -> Box<dyn HandlerId>

Subscribe to new solution notification

fn run(self: Box<Self>) -> Pin<Box<dyn Future<Output = Result<()>> + Send>>

Run and wait for background threads to exit or return an error