Struct Writer 

pub struct Writer<W> { /* private fields */ }

A pseudo-shuffled SAF file writer.

Note that the writer has a fallible drop check. See Writer::create and Writer::try_finish for more, as well as the module docs for general usage..

Implementations

impl<W> Writer<W>

pub fn try_finish(self) -> Result<()>

Consumes the writer fallibly.

This can be use to drop the writer and handle an error in the drop. See Writer::create for more information on when the writer can be dropped.

impl Writer<BufWriter<File>>

pub fn create<P>(path: P, header: Header) -> Result<Self>

where P: AsRef<Path>,

Creates a new pseudo-shuffled SAF file writer.

Note that this will pre-allocate the full disk space needed to fit the data described in the header. If the path already exists, it will be overwritten. The header information will be written to the file.

Since the full file space is pre-allocated, and since data is not written sequentially, it is considered an error if less sites are written than specified in the header. This condition is checked when dropping the reader, and the drop check will panic if the check is failed. See Writer::try_finish to handle the result of this check.

pub fn write_intersect<const D: usize, R, V>( self, intersect: Intersect<D, R, V>, ) -> Result<()>

where Intersect<D, R, V>: ReadSite<Site = Site<D>>, R: BufRead + Seek, V: Version,

Writes an entire reader to the writer.

Assumes that the reader contains the appropriate number of sites.

pub fn write_site(&mut self, values: &[f32]) -> Result<()>

Writes a single site to the writer.

No more sites can be written than specified in the header specified to Writer::create. Also, the number of values in site must match the sum of the shape provided in the header. If either of those conditions are not met, an error will be returned.

pub fn write_disjoint_site<I>(&mut self, values_iter: I) -> Result<()>

where I: IntoIterator, I::Item: AsRef<[f32]>, I::IntoIter: ExactSizeIterator,

Writes a single site split across multiple slices to the writer.

The different slices here may for instance correspond to different populations. As for Writer::write_site, no more sites can be than specified in the header specified to Writer::create. The provided sites must match the shape provided in the header. If either of those conditions are not met, an error will be returned.

Trait Implementations

impl<W> Drop for Writer<W>

fn drop(&mut self)

Executes the destructor for this type.