Enum Token 

#[non_exhaustive]
pub enum Token<'a> {
    Argb(ObjId, Argb),
    Artist(&'a str),
    AtBga {
        id: ObjId,
        source_bmp: ObjId,
        trim_top_left: (i16, i16),
        trim_size: (u16, u16),
        draw_point: (i16, i16),
    },
    Banner(&'a Path),
    BackBmp(&'a Path),
    Base62,
    BaseBpm(Decimal),
    Bga {
        id: ObjId,
        source_bmp: ObjId,
        trim_top_left: (i16, i16),
        trim_bottom_right: (i16, i16),
        draw_point: (i16, i16),
    },
    Bmp(Option<ObjId>, &'a Path),
    Bpm(Decimal),
    BpmChange(ObjId, Decimal),
    Case(BigUint),
    Cdda(BigUint),
    ChangeOption(ObjId, &'a str),
    CharFile(&'a Path),
    Charset(&'a str),
    Comment(&'a str),
    Def,
    DefExRank(u64),
    Difficulty(u8),
    DivideProp(&'a str),
    Else,
    ElseIf(BigUint),
    Email(&'a str),
    EndIf,
    EndRandom,
    EndSwitch,
    ExtChr(ExtChrEvent),
    ExBmp(ObjId, Argb, &'a Path),
    ExRank(ObjId, JudgeLevel),
    ExWav {
        id: ObjId,
        pan: ExWavPan,
        volume: ExWavVolume,
        frequency: Option<ExWavFrequency>,
        path: &'a Path,
    },
    Genre(&'a str),
    If(BigUint),
    LnMode(LnMode),
    LnObj(ObjId),
    LnTypeRdm,
    LnTypeMgq,
    Maker(&'a str),
    Materials(&'a Path),
    MaterialsBmp(&'a Path),
    MaterialsWav(&'a Path),
    Message {
        track: Track,
        channel: Channel,
        message: Cow<'a, str>,
    },
    MidiFile(&'a Path),
    Movie(&'a Path),
    NotACommand(&'a str),
    OctFp,
    Option(&'a str),
    PathWav(&'a Path),
    Player(PlayerMode),
    PlayLevel(u8),
    PoorBga(PoorMode),
    Preview(&'a Path),
    Random(BigUint),
    Rank(JudgeLevel),
    Scroll(ObjId, Decimal),
    Seek(ObjId, Decimal),
    SetRandom(BigUint),
    SetSwitch(BigUint),
    Skip,
    Speed(ObjId, Decimal),
    StageFile(&'a Path),
    Stop(ObjId, Decimal),
    Stp(StpEvent),
    SubArtist(&'a str),
    SubTitle(&'a str),
    SwBga(ObjId, SwBgaEvent),
    Switch(BigUint),
    Text(ObjId, &'a str),
    Title(&'a str),
    Total(Decimal),
    UnknownCommand(&'a str),
    Url(&'a str),
    VideoColors(u8),
    VideoDly(Decimal),
    VideoFile(&'a Path),
    VideoFs(Decimal),
    VolWav(Volume),
    Wav(ObjId, &'a Path),
    WavCmd(WavCmdEvent),
}

A token content of BMS format.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Argb(ObjId, Argb)

#ARGB[A1-A4] [A],[R],[G],[B] Extended transparent color definition.

• A1: BGA BASE
• A2: BGA LAYER
• A3: BGA LAYER 2
• A4: BGA POOR

Artist(&'a str)

#ARTIST [string]. Defines the artist name of the music.

AtBga

#@BGA[01-ZZ] [01-ZZ] [sx] [sy] [w] [h] [dx] [dy]. Defines the image object from trimming the existing image object.

Fields

id: ObjId

The id of the object to define.

source_bmp: ObjId

The id of the object to be trimmed.

trim_top_left: (i16, i16)

The top left point of the trim area in pixels.

trim_size: (u16, u16)

The size of the trim area in pixels.

draw_point: (i16, i16)

The top left point to be rendered in pixels.

Banner(&'a Path)

#BANNER [filename]. Defines the banner image. This can be used on music select or result view. It should be 300x80.

BackBmp(&'a Path)

#BACKBMP [filename]. Defines the background image file of the play view. It should be 640x480. The effect will depend on the skin of the player.

Base62

#BASE 62. Declares that the score is using base-62 object id format. If this exists, the score is treated as case-sensitive.

BaseBpm(Decimal)

#BASEBPM [f64] is the base BPM. It’s not used in LunaticRave2, replaced by its Hi-Speed Settings.

Bga

#BGA[01-ZZ] [01-ZZ] [x1] [y1] [x2] [y2] [dx] [dy]. Defines the image object from trimming the existing image object.

Fields

id: ObjId

The id of the object to define.

source_bmp: ObjId

The id of the object to be trimmed.

trim_top_left: (i16, i16)

The top left point of the trim area in pixels.

trim_bottom_right: (i16, i16)

The bottom right point of the trim area in pixels.

draw_point: (i16, i16)

The top left point to be rendered in pixels.

Bmp(Option<ObjId>, &'a Path)

#BMP[01-ZZ] [filename]. Defines the background image/movie object. The file specified may be not only BMP format, and also PNG, AVI, MP4, MKV and others. Its size should be less than or equal to 256x256. The black (#000000) pixel in the image will be treated as transparent. When the id 00 is specified, this first field will be None and the image will be shown when the player get mistaken.

Bpm(Decimal)

#BPM [f64]. Defines the base Beats-Per-Minute of the score. Defaults to 130, but some players don’t conform to it.

BpmChange(ObjId, Decimal)

#BPM[01-ZZ] [f64]. Defines the Beats-Per-Minute change object.

Case(BigUint)

#CASE [u32]. Starts a case scope if the integer equals to the generated random number. If there’s no #SKIP command in the scope, the parsing will fallthrough to the next #CASE or #DEF. See also Token::Switch.

Cdda(BigUint)

#CDDA [u64]. CD-DA (Compact Disc Digital Audio) extension. CD-DA can be used as BGM (Background Music). In DDR (Dance Dance Revolution), a config of CD-Syncro in SYSTEM OPTION is also applied. This allows the game to play audio directly from a CD drive.

ChangeOption(ObjId, &'a str)

#CHANGEOPTION[01-ZZ] [string]. Defines the play option change object. Some players interpret and apply the preferences.

CharFile(&'a Path)

#CHARFILE [filename]. The character file similar to pop’n music. It’s filextension is .chp. For now, #CHARFILE is a pomu2 proprietary extension. However, the next-generation version LunaticRave may support #CHARFILE.

Charset(&'a str)

#CHARSET [string] Charset declaration. Default is SHIFT-JIS.

Comment(&'a str)

#COMMENT [string]. Defines the text which is shown in the music select view. This may or may not be surrounded by double-quotes.

Def

#DEF. Starts a case scope if any #CASE had not matched to the generated random number. It must be placed in the end of the switch scope. See also Token::Switch.

DefExRank(u64)

#DEFEXRANK [u64] Extended judge rank definition, defined as n% of the original. 100 means NORMAL judge. Overrides #RANK definition.

Difficulty(u8)

#DIFFICULTY [1-5]. Defines the difficulty of the score. It can be used to sort the score having the same title.

DivideProp(&'a str)

#DIVIDEPROP [string] The resolution of Measure of BMS is specified. Deprecated.

Else

#ELSEIF [u32]. Starts an if scope when the preceding #IF had not matched to the generated random number. It must be in an if scope.

ElseIf(BigUint)

#ELSEIF [u32]. Starts an if scope when the integer equals to the generated random number. It must be in an if scope. If preceding #IF had matched to the generated, this scope don’t start. Syntax sugar for:

#ELSE
  #IF n
  // ...
  #ENDIF
#ENDIF

Email(&'a str)

%EMAIL [string]. The email address of this score file author.

EndIf

#ENDIF. Closes the if scope. See Token::If.

EndRandom

#ENDRANDOM. Closes the random scope. See Token::Random.

EndSwitch

#ENDSW. Closes the random scope. See Token::Switch.

ExtChr(ExtChrEvent)

#ExtChr SpriteNum BMPNum startX startY endX endY [offsetX offsetY [x y]] BM98 extended character customization.

ExBmp(ObjId, Argb, &'a Path)

#BMP[01-ZZ] [0-255],[0-255],[0-255],[0-255] [filename]. Defines the background image/movie object with the color (alpha, red, green and blue) which will be treated as transparent.

ExRank(ObjId, JudgeLevel)

#EXRANK[01-ZZ] [0-3]. Defines the judgement level change object.

ExWav

#EXWAV[01-ZZ] [parameter order] [pan or volume or frequency; 1-3] [filename]. Defines the key sound object with the effect of pan, volume and frequency.

Fields

id: ObjId

The id of the object to define.

pan: ExWavPan

The pan decay of the sound. Also called volume balance.

volume: ExWavVolume

The volume decay of the sound.

frequency: Option<ExWavFrequency>

The pitch frequency of the sound.

path: &'a Path

The relative file path of the sound.

Genre(&'a str)

#GENRE [string]. Defines the genre of the music.

If(BigUint)

#IF [u32]. Starts an if scope when the integer equals to the generated random number. This must be placed in a random scope. See also Token::Random.

LnMode(LnMode)

#LNMODE [1:LN, 2:CN, 3:HCN] Explicitly specify LN type for this chart.

LnObj(ObjId)

#LNOBJ [01-ZZ]. Declares the object as the end of an LN. The preceding object of the declared will be treated as the beginning of an LN.

LnTypeRdm

#LNTYPE 1. Declares the LN notation as the RDM type.

LnTypeMgq

#LNTYPE 2. Declares the LN notation as the MGQ type.

Maker(&'a str)

#MAKER [string]. Defines the author name of the score.

Materials(&'a Path)

#MATERIALS [string] Material path definition. Defines the relative path which makes an executable file a starting point. This allows BMS files to reference files in Materials subdirectories using <foldername>filename syntax.

MaterialsBmp(&'a Path)

#MATERIALSBMP [filename] Material BMP extension. Deprecated.

MaterialsWav(&'a Path)

#MATERIALSWAV [filename] Material WAV extension. Deprecated.

Message

#XXXYY:ZZ.... Defines the message which places the object onto the score. XXX is the track, YY is the channel, and ZZ... is the object id sequence.

Fields

track: Track

The track, or measure, must start from 1. But some player may allow the 0 measure (i.e. Lunatic Rave 2).

channel: Channel

The channel commonly expresses what the lane be arranged the note to.

message: Cow<'a, str>

The message to the channel.

MidiFile(&'a Path)

#MIDIFILE [filename]. Defines the MIDI file as the BGM. This is a minor command extension that allows MIDI files to be used as background music. Deprecated - Some players may not support this feature.

Movie(&'a Path)

#MOVIE [filename] DXEmu extension, defines global video file.

• Video starts from #000.
• Priority rules:
  • If #xxx04 is an image file (BMP, PNG, etc.), #MOVIE has priority.
  • If both #xxx04 and #MOVIE are video files, #xxx04 has priority.
• No loop, stays on last frame after playback.
• Audio track in video is not played.

NotACommand(&'a str)

Non-empty lines that not starts in '#' in bms file.

OctFp

#OCT/FP. Declares the score as the octave mode. This is a minor command extension that enables octave mode for the chart. In octave mode, the chart may have different note arrangements or gameplay mechanics.

Option(&'a str)

#OPTION [string]. Defines the play option of the score. Some players interpret and apply the preferences.

PathWav(&'a Path)

#PATH_WAV [string]. Defines the root path of Token::Wav paths. This should be used only for tests.

Player(PlayerMode)

#PLAYER [1-4]. Defines the play style of the score.

PlayLevel(u8)

#PLAYLEVEL [integer]. Defines the difficulty level of the score. This can be used on music select view.

PoorBga(PoorMode)

#POORBGA [0-2]. Defines the display mode of the POOR BGA.

Preview(&'a Path)

#PREVIEW [filename] Preview audio file for music selection.

Random(BigUint)

#RANDOM [u32]. Starts a random scope which can contain only #IF-#ENDIF scopes. The random scope must close with #ENDRANDOM. A random integer from 1 to the integer will be generated when parsing the score. Then if the integer of #IF equals to the random integer, the commands in an if scope will be parsed, otherwise all command in it will be ignored. Any command except #IF and #ENDIF must not be included in the scope, but some players allow it.

Rank(JudgeLevel)

#RANK [0-3]. Defines the judgement level.

Scroll(ObjId, Decimal)

#SCROLL[01-ZZ] [f64]. Defines the scroll speed change object. It changes relative falling speed of notes with keeping BPM. For example, if applying 2.0, the scroll speed will become double.

Seek(ObjId, Decimal)

#SEEK[01-ZZ] [f64] Video seek extension. Defines a video seek event that allows jumping to specific time positions in video files. This is a minor command extension for advanced video control.

SetRandom(BigUint)

#SETRANDOM [u32]. Starts a random scope but the integer will be used as the generated random number. It should be used only for tests.

SetSwitch(BigUint)

#SETSWITCH [u32]. Starts a switch scope but the integer will be used as the generated random number. It should be used only for tests.

Skip

#SKIP. Escapes the current switch scope. It is often used in the end of every case scope.

Speed(ObjId, Decimal)

#SPEED[01-ZZ] [f64]. Defines the spacing change object. It changes relative spacing of notes with linear interpolation. For example, if playing score between the objects 1.0 and 2.0, the spaces of notes will increase at the certain rate until the 2.0 object.

StageFile(&'a Path)

#STAGEFILE [filename]. Defines the splashscreen image. It should be 640x480.

Stop(ObjId, Decimal)

#STOP[01-ZZ] [0-4294967295]. Defines the stop object. The scroll will stop the beats of the integer divided by 192. A beat length depends on the current BPM. If there are other objects on same time, the stop object must be evaluated at last.

Stp(StpEvent)

#STP xxx.yyy zzzz bemaniaDX STOP sequence.

SubArtist(&'a str)

#SUBARTIST [string]. Defines the sub-artist name of the music.

SubTitle(&'a str)

#SUBTITLE [string]. Defines the subtitle of the music.

SwBga(ObjId, SwBgaEvent)

#SWBGA[01-ZZ] fr:time:line:loop:a,r,g,b pattern Key Bind Layer Animation.

Switch(BigUint)

#SWITCH [u32]. Starts a switch scope which can contain only #CASE or #DEF scopes. The switch scope must close with #ENDSW. A random integer from 1 to the integer will be generated when parsing the score. Then if the integer of #CASE equals to the random integer, the commands in a case scope will be parsed, otherwise all command in it will be ignored. Any command except #CASE and #DEF must not be included in the scope, but some players allow it.

Text(ObjId, &'a str)

#TEXT[01-ZZ] string. Defines the text object.

Title(&'a str)

#TITLE [string]. Defines the title of the music.

Total(Decimal)

#TOTAL [f64]. Defines the total gauge percentage when all notes is got as PERFECT.

UnknownCommand(&'a str)

Unknown Part. Includes all the line that not be parsed.

Url(&'a str)

%URL [string]. The url of this score file.

VideoColors(u8)

#VIDEOCOLORS [u8] Video color depth, default 16Bit. Defines the color depth for video playback. Common values are 16, 24, or 32 bits. This affects the quality and performance of video rendering.

VideoDly(Decimal)

#VIDEODLY [f64] Video delay extension. Defines a delay in seconds before video playback starts. This is useful for synchronizing video with audio or other game elements.

VideoFile(&'a Path)

#VIDEOFILE [filename] / #MOVIE [filename]. Defines the background movie file. The audio track in the movie file should not be played. The play should start from the track 000.

VideoFs(Decimal)

#VIDEOF/S [f64] Video file frame rate. Defines the frame rate for video playback in frames per second (FPS). This affects the smoothness and timing of video playback.

VolWav(Volume)

#VOLWAV [0-255]. Defines the relative volume percentage of the sound in the score.

Wav(ObjId, &'a Path)

#WAV[01-ZZ] [filename]. Defines the key sound object. When same id multiple objects ring at same time, it must be played only one. The file specified may be not only WAV format, and also OGG, MP3 and others.

WavCmd(WavCmdEvent)

#WAVCMD [param] [wav-index] [value] MacBeat extension, pseudo-MOD effect.

Implementations

impl<'a> Token<'a>

pub const fn is_control_flow_token(&self) -> bool

Checks if a token is a control flow token.

Trait Implementations

impl<'a> Clone for Token<'a>

fn clone(&self) -> Token<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Token<'a>

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

Formats the value using the given formatter.

impl Display for Token<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for Token<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Token<'a>

fn eq(&self, other: &Token<'a>) -> 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<'a> Serialize for Token<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Token<'a>

impl<'a> StructuralPartialEq for Token<'a>