Struct SampleReader 

pub struct SampleReader<R> { /* private fields */ }

Streams frames of samples out of a Read source.

See SampleWriter for an example.

Implementations

impl<R: Read> SampleReader<R>

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

Creates a reader that decodes channel_count-channel frames of datatype from reader.

Errors

Returns SigmfError::InvalidMetadata if channel_count is zero or the frame size overflows.

pub fn read_frames( &mut self, maximum_frames: usize, ) -> Result<Option<Vec<SampleValue>>, SigmfError>

Reads and decodes up to maximum_frames frames.

Short and interrupted reads are retried until maximum_frames frames are available or the source reaches end of input. Returns Ok(Some(samples)) with between one and maximum_frames frames (one SampleValue per channel per frame), or Ok(None) once the source is exhausted. A buffer for maximum_frames frames is allocated on each call.

Errors

Returns SigmfError::InvalidRange if maximum_frames is zero, SigmfError::ResourceLimit if the block size overflows, SigmfError::InvalidMetadata if the source ends with an incomplete frame, or SigmfError::Io if reading fails.