Struct Notes 

pub struct Notes<T> {
    pub wav_path_root: Option<PathBuf>,
    pub wav_files: HashMap<ObjId, PathBuf>,
    pub midi_file: Option<PathBuf>,
    pub materials_wav: Vec<PathBuf>,
    pub bgm_volume_changes: BTreeMap<ObjTime, BgmVolumeObj>,
    pub key_volume_changes: BTreeMap<ObjTime, KeyVolumeObj>,
    pub seek_events: BTreeMap<ObjTime, SeekObj>,
    pub text_events: BTreeMap<ObjTime, TextObj>,
    pub judge_events: BTreeMap<ObjTime, JudgeObj>,
    pub bga_keybound_events: BTreeMap<ObjTime, BgaKeyboundObj>,
    pub option_events: BTreeMap<ObjTime, OptionObj>,
    /* private fields */
}

The playable objects set for querying by lane or time.

Fields

wav_path_root: Option<PathBuf>

The path to override the base path of the WAV file path. This allows WAV files to be referenced relative to a different directory.

wav_files: HashMap<ObjId, PathBuf>

The WAV file paths corresponding to the id of the note object.

midi_file: Option<PathBuf>

The path of MIDI file, which is played as BGM while playing the score.

materials_wav: Vec<PathBuf>

Material WAV file paths. #MATERIALSWAV

bgm_volume_changes: BTreeMap<ObjTime, BgmVolumeObj>

BGM volume change events, indexed by time. #97

key_volume_changes: BTreeMap<ObjTime, KeyVolumeObj>

KEY volume change events, indexed by time. #98

seek_events: BTreeMap<ObjTime, SeekObj>

Seek events, indexed by time. #05

text_events: BTreeMap<ObjTime, TextObj>

Text events, indexed by time. #99

judge_events: BTreeMap<ObjTime, JudgeObj>

Judge events, indexed by time. #A0

bga_keybound_events: BTreeMap<ObjTime, BgaKeyboundObj>

BGA keybound events, indexed by time. #A5

option_events: BTreeMap<ObjTime, OptionObj>

Option events, indexed by time. #A6

Implementations

impl<T> Notes<T>

pub fn is_empty(&self) -> bool

Checks whether there is no valid notes.

pub fn into_all_notes(self) -> Vec<WavObj>

Converts into the notes.

pub fn all_notes(&self) -> impl Iterator<Item = &WavObj>

Returns the iterator having all of the notes sorted by time.

pub fn all_entries(&self) -> impl Iterator<Item = (WavObjArenaIndex, &WavObj)>

Returns the iterator having all of the notes and its index sorted by time.

pub fn playables(&self) -> impl Iterator<Item = &WavObj>

where T: KeyLayoutMapper,

Returns all the playable notes in the score.

pub fn displayables(&self) -> impl Iterator<Item = &WavObj>

where T: KeyLayoutMapper,

Returns all the displayable notes in the score.

pub fn bgms(&self) -> impl Iterator<Item = &WavObj>

where T: KeyLayoutMapper,

Returns all the bgms in the score.

pub fn notes_on( &self, channel_id: NoteChannelId, ) -> impl Iterator<Item = (WavObjArenaIndex, &WavObj)>

where T: KeyLayoutMapper,

Retrieves notes on the specified channel id by the key mapping T.

pub fn notes_in<R: RangeBounds<ObjTime>>( &self, time_span: R, ) -> impl DoubleEndedIterator<Item = (WavObjArenaIndex, &WavObj)>

Retrieves notes in the specified time span.

pub fn next_obj_by_key( &self, channel_id: NoteChannelId, time: ObjTime, ) -> Option<&WavObj>

Finds next object on the key Key from the time ObjTime.

pub fn last_obj_time(&self) -> Option<ObjTime>

Gets the latest starting time of all notes.

pub fn last_playable_time(&self) -> Option<ObjTime>

where T: KeyLayoutMapper,

Gets the time of last playable object.

pub fn last_bgm_time(&self) -> Option<ObjTime>

where T: KeyLayoutMapper,

Gets the time of last BGM object.

You can’t use this to find the length of music. Because this doesn’t consider that the length of sound. And visible notes may ring after all BGMs.

impl<T> Notes<T>

pub fn push_note(&mut self, note: WavObj)

Adds the new note object to the notes.

pub fn pop_note(&mut self) -> Option<WavObj>

Removes the latest note from the notes.

pub fn remove_note(&mut self, wav_id: ObjId) -> Vec<WavObj>

where T: KeyLayoutMapper,

Removes notes belonging to the wav id.

pub fn pop_by_idx(&mut self, idx: WavObjArenaIndex) -> Option<WavObj>

Removes a note of the specified index idx.

pub fn pop_latest_of(&mut self, wav_id: ObjId) -> Option<WavObj>

where T: KeyLayoutMapper,

Removes the latest note using the wav of wav_id.

pub fn push_bgm(&mut self, time: ObjTime, wav_id: ObjId)

where T: KeyLayoutMapper,

Adds the BGM (auto-played) note of wav_id at time.

pub fn push_wav<P: Into<PathBuf>>( &mut self, wav_id: ObjId, path: P, ) -> Option<PathBuf>

Links the wav file path to the object id wav_id. Then returns the old path if existed.

pub fn remove_wav(&mut self, wav_id: &ObjId) -> Option<PathBuf>

Unlinks the wav file path from the object id wav_id, and return the path if existed.

pub fn retain_notes<F: FnMut(&WavObj) -> bool>(&mut self, cond: F)

where T: KeyLayoutMapper,

Retains note objects with the condition cond. It keeps only the WavObjs which cond returned true.

pub fn dup_note_into(&mut self, src: ObjId, at: ObjTime, dst: NoteChannelId)

Duplicates the object with id src at the time at into the channel of id dst.

pub fn push_bgm_volume_change( &mut self, volume_obj: BgmVolumeObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new BGM volume change object to the notes.

pub fn push_key_volume_change( &mut self, volume_obj: KeyVolumeObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new KEY volume change object to the notes.

pub fn push_seek_event( &mut self, seek_obj: SeekObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new seek object to the notes.

pub fn push_text_event( &mut self, text_obj: TextObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new text object to the notes.

pub fn push_judge_event( &mut self, judge_obj: JudgeObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new judge object to the notes.

pub fn push_bga_keybound_event( &mut self, keybound_obj: BgaKeyboundObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new BGA keybound object to the notes.

pub fn push_option_event( &mut self, option_obj: OptionObj, prompt_handler: &mut impl PromptHandler, ) -> Result<(), ParseWarning>

Adds a new option object to the notes.

impl<T> Notes<T>

pub fn change_note_channel<I>(&mut self, targets: I, dst: NoteChannelId)

where T: KeyLayoutMapper, I: IntoIterator<Item = WavObjArenaIndex>,

Changes the channel of notes target in time_span into another channel dst.

pub fn change_note_time( &mut self, target: WavObjArenaIndex, new_time: ObjTime, ) -> Option<ObjTime>

Changes the specified object target’s offset time into new_time.

Trait Implementations

impl<T: Clone> Clone for Notes<T>

fn clone(&self) -> Notes<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Notes<T>

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

Formats the value using the given formatter.

impl<T> Default for Notes<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Notes<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Notes<T>

fn eq(&self, other: &Notes<T>) -> 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<T> Serialize for Notes<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Notes<T>

impl<T> StructuralPartialEq for Notes<T>