Struct cybergrape::spatial_data_format::GrapeFileBuilder

pub struct GrapeFileBuilder {
    sample_rate: u64,
    streams: Vec<(GrapeTag, Vec<f32>)>,
}

This builder contains the data required

Fields

sample_rate: u64

streams: Vec<(GrapeTag, Vec<f32>)>

Implementations

impl GrapeFileBuilder

fn new() -> Self

Instaintiate a builder with no streams and a default sample rate of 1000 samples per second.

pub fn set_samplerate(self, sample_rate: u64) -> Self

Sets the sample rate of the builder to the argument.

pub fn add_stream(self, stream: &[f32], tag: GrapeTag) -> Self

Adds a tagged stream to the builder.

pub fn clear_streams(self) -> Self

Removes all streams from the builder

pub fn build_truncate(self) -> GrapeFile

Builds a GrapeFile from the builder, truncating all streams to the length of the shortest stream.

pub fn build_extend(self) -> GrapeFile

Builds a GrapeFile from the builder, extending all streams with the last value recorded in each stream.

pub fn build(self) -> Result<GrapeFile, GrapeFileError>

Builds a GrapeFile from a builder, returning the GrapeFile if all streams are of the same length, and GrapeFileError::UnequalSampleBufferLengths otherwise.

Trait Implementations

impl Clone for GrapeFileBuilder

fn clone(&self) -> GrapeFileBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrapeFileBuilder

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

Formats the value using the given formatter.

impl Default for GrapeFileBuilder

fn default() -> Self

Returns the “default value” for a type.