Module sector

Source
Expand description

Sector-related data structures

Sectors and corresponding metadata created by functions in plotting module have a specific structure, represented by data structured in this module.

It is typically not needed to construct these data structures explicitly outside of this crate, instead they will be returned as a result of certain operations (like plotting).

Structs§

EncodedChunksUsed
Wrapper data structure that allows to iterate mutably over encoded chunks bitfields, while maintaining up-to-date number of encoded chunks
SectorContentsMap
Map of sector contents.
SectorMetadata
Metadata of the plotted sector
SectorMetadataChecksummed
Same as SectorMetadata, but with checksums verified during SCALE encoding/decoding

Enums§

SectorContentsMapEncodeIntoError
Error happening when trying to encode SectorContentsMap into bytes
SectorContentsMapFromBytesError
Error happening when trying to create SectorContentsMap from bytes
SectorContentsMapIterationError
Error happening when trying to create SectorContentsMap from bytes

Functions§

sector_record_chunks_size
Size of the part of the plot containing record chunks (s-buckets).
sector_record_metadata_size
Size of the part of the plot containing record metadata.
sector_size
Exact sector plot size (sector contents map, record chunks, record metadata).