Struct Bms 

pub struct Bms<T = KeyLayoutBeat> {
    pub header: Header,
    pub scope_defines: ScopeDefines,
    pub arrangers: Arrangers,
    pub notes: Notes<T>,
    pub graphics: Graphics,
    pub others: Others,
}

A score data aggregate of BMS format.

Fields

header: Header

The header data in the score.

scope_defines: ScopeDefines

The scope-defines in the score.

arrangers: Arrangers

The arranges in the score. Contains timing and arrangement data like BPM changes, stops, and scrolling factors.

notes: Notes<T>

The objects in the score. Contains all note objects, BGM events, and audio file definitions.

graphics: Graphics

The graphics part in the score. Contains background images, videos, BGA events, and visual elements.

others: Others

The other part in the score. Contains miscellaneous data like text objects, options, and non-standard commands.

Implementations

impl<T> Bms<T>

pub fn notes(&self) -> &Notes<T>

Returns the sound note objects information.

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.

pub fn resolution_for_pulses(&self) -> u64

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

impl<T: KeyLayoutMapper> Bms<T>

pub fn check_playing(&self) -> PlayingCheckOutput

Check for playing warnings and errors based on the parsed BMS data.

impl Bms

pub fn check_validity(&self) -> ValidityCheckOutput

Validate the internal consistency of Bms after parsing or manual edits.

This performs basic referential integrity checks and data invariants that are required for correct playback, separate from parse-time checks.

impl<T: KeyLayoutMapper> Bms<T>

pub fn from_token_stream<'a>( token_iter: impl IntoIterator<Item = &'a TokenWithRange<'a>>, prompt_handler: impl PromptHandler, ) -> ParseOutput<T>

Parses a token stream into Bms without AST.

impl<T: KeyLayoutMapper> Bms<T>

pub fn from_token_stream_with_ast<'a>( token_iter: impl IntoIterator<Item = &'a TokenWithRange<'a>>, rng: impl Rng, prompt_handler: impl PromptHandler, ) -> ParseOutputWithAst<T>

Parses a token stream into Bms with AST.

impl Bms

pub fn to_bmson(self) -> BmsToBmsonOutput

Available on crate feature bmson only.

Convert Bms to Bmson.

impl Bms

pub fn from_bmson(value: Bmson) -> BmsonToBmsOutput

Available on crate feature bmson only.

Convert Bmson to Bms.

Trait Implementations

impl<T: Clone> Clone for Bms<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Bms<T>

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

Formats the value using the given formatter.

impl<T: KeyLayoutMapper> Default for Bms<T>

fn default() -> Self

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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 Bms<T>

fn eq(&self, other: &Bms<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 Bms<T>

where T: Serialize,

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 Bms<T>

impl<T> StructuralPartialEq for Bms<T>