Struct sorceress::synthdef::decoder::SynthDefFile

pub struct SynthDefFile {
    pub type_id: i32,
    pub version: i32,
    pub synth_defs: Vec<SynthDef>,
}

The root of a decoded synth definition file.

Fields

type_id: i32

Four byte file type id containing the ASCII characters: “SCgf”.

This field is not validated by the decoder.

version: i32

The file version, currently 2.

synth_defs: Vec<SynthDef>

The synth definitions contained by this file.

Implementations

impl SynthDefFile

pub fn decode<R: Read>(read: R) -> Result<SynthDefFile, Error>

Decodes a synth definition file.

See the module level documentation for more.

Errors

• Returns Error::IO if the function encounters an I/O error reading the input.
• Returns Error::BadTypeID if the type ID field in the file header is incorrect.

Trait Implementations

impl Clone for SynthDefFile

fn clone(&self) -> SynthDefFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SynthDefFile

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

Formats the value using the given formatter.

impl PartialEq<SynthDefFile> for SynthDefFile

fn eq(&self, other: &SynthDefFile) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SynthDefFile) -> bool

This method tests for !=.

impl PartialOrd<SynthDefFile> for SynthDefFile

fn partial_cmp(&self, other: &SynthDefFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SynthDefFile