Struct SampleWriter 

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

Streams frames of samples into a Write destination.

Each call to write_frames encodes its samples with encode and writes them immediately; wrap the destination in a std::io::BufWriter when writing many small blocks to a file.

Examples

use sigmf::datatype::Datatype;
use sigmf::utils::data::{SampleReader, SampleValue, SampleWriter};
use std::io::Cursor;
use std::str::FromStr;

let datatype = Datatype::from_str("rf32_be")?;
let mut writer = SampleWriter::new(Vec::new(), datatype.clone(), 1)?;
writer.write_frames(&[SampleValue::RealF32(0.5), SampleValue::RealF32(-1.0)])?;
writer.write_frames(&[SampleValue::RealF32(2.0)])?;
let bytes = writer.finish()?;
assert_eq!(bytes.len(), 12);

let mut reader = SampleReader::new(Cursor::new(bytes), datatype, 1)?;
assert_eq!(
    reader.read_frames(2)?,
    Some(vec![SampleValue::RealF32(0.5), SampleValue::RealF32(-1.0)])
);
assert_eq!(reader.read_frames(2)?, Some(vec![SampleValue::RealF32(2.0)]));
assert_eq!(reader.read_frames(2)?, None);

Implementations

impl<W: Write> SampleWriter<W>

pub fn new( writer: W, datatype: Datatype, channel_count: usize, ) -> Result<Self, SigmfError>

Creates a writer that encodes channel_count-channel frames of datatype into writer.

Errors

Returns SigmfError::InvalidMetadata if channel_count is zero.

pub fn write_frames( &mut self, samples: &[SampleValue], ) -> Result<(), SigmfError>

Encodes and writes one block of complete frames.

Errors

Returns any error from encode (in which case nothing is written), or SigmfError::Io if writing fails.

pub fn finish(self) -> Result<W, SigmfError>

Flushes the destination and returns it.

Errors

Returns SigmfError::Io if flushing fails.