Struct bms_rs::parse::notes::Notes

source ·
pub struct Notes { /* private fields */ }
Expand description

The objects set for querying by lane or time.

Implementations§

source§

impl Notes

source

pub fn new() -> Self

Creates a new notes dictionary.

source

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

Converts into the notes sorted by time.

source

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

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

source

pub fn bgms(&self) -> &BTreeMap<ObjTime, Vec<ObjId>>

Returns all the bgms in the score.

source

pub fn bpm_changes(&self) -> &BTreeMap<ObjTime, BpmChangeObj>

Returns the bpm change objects.

source

pub fn section_len_changes(&self) -> &BTreeMap<Track, SectionLenChangeObj>

Returns the section len change objects.

source

pub fn stops(&self) -> &BTreeMap<ObjTime, StopObj>

Returns the scroll stop objects.

source

pub fn bga_changes(&self) -> &BTreeMap<ObjTime, BgaObj>

Returns the bga change objects.

source

pub fn next_obj_by_key(&self, key: Key, time: ObjTime) -> Option<&Obj>

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

source

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

Adds the new note object to the notes.

source

pub fn remove_note(&mut self, id: ObjId) -> Option<Obj>

Removes the note from the notes.

source

pub fn push_bpm_change(&mut self, bpm_change: BpmChangeObj)

Adds a new BPM change object to the notes.

source

pub fn push_section_len_change( &mut self, section_len_change: SectionLenChangeObj )

Adds a new section length change object to the notes.

source

pub fn push_stop(&mut self, stop: StopObj)

Adds a new stop object to the notes.

source

pub fn push_bga_change(&mut self, bga: BgaObj)

Adds a new bga change object to the notes.

source

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

Gets the time of last visible object.

source

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

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.

source

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

Gets the time of last any object including visible, BGM, BPM change, section length change and so on.

You can’t use this to find the length of music. Because this doesn’t consider that the length of sound.

source

pub fn resolution_for_pulses(&self) -> u32

Calculates a required resolution to convert the notes time into pulses, which split one quarter note evenly.

Trait Implementations§

source§

impl Debug for Notes

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Notes

source§

fn default() -> Notes

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Notes

§

impl Send for Notes

§

impl Sync for Notes

§

impl Unpin for Notes

§

impl UnwindSafe for Notes

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.