Enum ultrastar_txt::structs::Note

pub enum Note {
    Regular {
        start: i32,
        duration: i32,
        pitch: i32,
        text: String,
    },
    Golden {
        start: i32,
        duration: i32,
        pitch: i32,
        text: String,
    },
    Freestyle {
        start: i32,
        duration: i32,
        pitch: i32,
        text: String,
    },
    PlayerChange {
        player: i32,
    },
}

Describes the different types of notes the parser might encounter

Variants

Regular

a regular note

Fields of Regular

start: i32

start of the note

duration: i32

duration of the note

pitch: i32

pitch of the note (in semitones with C2 being 0)

text: String

text or syllable of the note

Golden

a golden note (2x points)

Fields of Golden

start: i32

start of the note

duration: i32

duration of the note

pitch: i32

pitch of the note (in semitones with C2 being 0)

text: String

text or syllable of the note

Freestyle

a freestyle note (note that does not award points)

Fields of Freestyle

start: i32

start of the note

duration: i32

duration of the note

pitch: i32

pitch of the note (in semitones with C2 being 0)

text: String

text or syllable of the note

PlayerChange

player change indicator for duet mode

Fields of PlayerChange

player: i32

player to change to 1 = Player1 2 = Player2 3 = Both

Methods

impl Note

pub fn start(&self) -> Option<i32>

returns the start value of the note

pub fn duration(&self) -> Option<i32>

returns the duration value of the note

pub fn pitch(&self) -> Option<i32>

returns the pitch value of the note

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

returns a refernece to the text of the note

pub fn player(&self) -> Option<i32>

returns player change number for duett mode

Trait Implementations

impl PartialEq<Note> for Note

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

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

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

This method tests for !=.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.