Struct Music 

pub struct Music { /* private fields */ }

Music object built from an MML script.

Implementations

impl Music

pub fn new(script: &str) -> Result<Self, ParseMusicError>

Parses the given MML script and creates a Music instance.

This is equivalent with script.parse::<Music>().

pub fn title(&self) -> Option<&str>

Music title defined by #TITLE <VALUE> in the script.

pub fn composer(&self) -> Option<&str>

Name of the composer of this music defined by #COMPOSER <VALUE> in the script.

pub fn programer(&self) -> Option<&str>

Name of the programmer who wrote this music script defined by #PROGRAMER <VALUE> in the script.

Note that the typo is intentional.

pub fn play(&self, sample_rate: u16) -> MusicPlayer

Returns a MusicPlayer instance that generates audio samples.

Trait Implementations

impl Clone for Music

fn clone(&self) -> Music

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Music

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

Formats the value using the given formatter.

impl FromStr for Music

type Err = ParseMusicError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.