Struct Song

pub struct Song {

    pub version: Version,
    pub directory: String,
    pub transpose: u8,
    pub tempo: f32,
    pub quantize: u8,
    pub name: String,
    pub key: u8,
    pub song: SongSteps,
    pub phrases: Vec<Phrase>,
    pub chains: Vec<Chain>,
    pub instruments: Vec<Instrument>,
    pub tables: Vec<Table>,
    pub grooves: Vec<Groove>,
    pub scales: Vec<Scale>,
    pub mixer_settings: MixerSettings,
    pub effects_settings: EffectsSettings,
    pub midi_settings: MidiSettings,
    pub midi_mappings: Vec<MidiMapping>,
    pub eqs: Vec<Equ>,
}

Fields

version: Version

directory: String

transpose: u8

tempo: f32

quantize: u8

name: String

key: u8

song: SongSteps

phrases: Vec<Phrase>

chains: Vec<Chain>

instruments: Vec<Instrument>

tables: Vec<Table>

grooves: Vec<Groove>

scales: Vec<Scale>

mixer_settings: MixerSettings

effects_settings: EffectsSettings

midi_settings: MidiSettings

midi_mappings: Vec<MidiMapping>

eqs: Vec<Equ>

Implementations

impl Song

pub const N_PHRASES: usize = 255usize

pub const N_CHAINS: usize = 255usize

pub const N_INSTRUMENTS: usize = 128usize

pub const N_TABLES: usize = 256usize

pub const N_GROOVES: usize = 32usize

pub const N_SCALES: usize = 16usize

pub const N_MIDI_MAPPINGS: usize = 128usize

pub fn phrase_view(&self, ix: usize) -> PhraseView<'_>

pub fn offsets(&self) -> &'static Offsets

pub fn eq_count(&self) -> usize

pub fn table_view(&self, ix: usize) -> TableView<'_>

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

pub fn read(reader: &mut impl Read) -> M8Result<Self>

Examples found in repository

examples/read_song.rs (line 18)

fn run() -> Result<(), Box<dyn Error>> {
    let args: Vec<String> = env::args().collect();

    let mut f = File::open(&args[1])?;
    let song = Song::read(&mut f)?;

    dbg!(&song);
    dbg!(&song.eqs);

    Ok(())
}

pub fn read_from_reader(reader: &mut Reader) -> M8Result<Self>

pub fn write(&self, w: &mut Writer) -> Result<(), String>

Trait Implementations

impl Clone for Song

fn clone(&self) -> Song

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Song

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

Formats the value using the given formatter.

impl PartialEq for Song

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Song