Struct Header

pub struct Header { /* private fields */ }

The header for a pseudo-shuffled SAF file.

The header is written at the top of the file, and contains information about the size and layout of the file.

Implementations

impl Header

pub fn blocks(&self) -> usize

Returns the number of blocks used for shuffling.

pub fn data_size(&self) -> usize

Returns the size (in bytes) of the data that the file is expected to contain.

pub fn file_size(&self) -> usize

Returns the size (in bytes) of the entire file.

This is equal to the size of the header and the size of the data.

pub fn header_size(&self) -> usize

Returns the size (in bytes) of the header as it will be written to a file.

pub fn new(sites: usize, shape: Vec<usize>, blocks: usize) -> Self

Creates a new header.

pub fn shape(&self) -> &[usize]

Returns the shape of each site in the file.

pub fn sites(&self) -> usize

Returns the number of sites in the file.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

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

impl StructuralPartialEq for Header