Struct osu_file_parser::osu_file::general::General

pub struct General {

    pub audio_filename: Option<AudioFilename>,
    pub audio_lead_in: Option<AudioLeadIn>,
    pub audio_hash: Option<AudioHash>,
    pub preview_time: Option<PreviewTime>,
    pub countdown: Option<Countdown>,
    pub sample_set: Option<SampleSet>,
    pub stack_leniency: Option<StackLeniency>,
    pub mode: Option<Mode>,
    pub letterbox_in_breaks: Option<LetterboxInBreaks>,
    pub story_fire_in_front: Option<StoryFireInFront>,
    pub use_skin_sprites: Option<UseSkinSprites>,
    pub always_show_playfield: Option<AlwaysShowPlayfield>,
    pub overlay_position: Option<OverlayPosition>,
    pub skin_preference: Option<SkinPreference>,
    pub epilepsy_warning: Option<EpilepsyWarning>,
    pub countdown_offset: Option<CountdownOffset>,
    pub special_style: Option<SpecialStyle>,
    pub widescreen_storyboard: Option<WidescreenStoryboard>,
    pub samples_match_playback_rate: Option<SamplesMatchPlaybackRate>,
    pub editor_bookmarks: Option<EditorBookmarks>,
    pub editor_distance_spacing: Option<EditorDistanceSpacing>,
}

A struct representing the general section of an osu file.

Fields

audio_filename: Option<AudioFilename>

The name of the beatmap.

audio_lead_in: Option<AudioLeadIn>

Milliseconds of silence before the audio starts playing.

audio_hash: Option<AudioHash>

Deprecated.

preview_time: Option<PreviewTime>

Time in milliseconds when the audio preview should start.

• Defaults to -1.

countdown: Option<Countdown>

Speed of the countdown before the first hit object.

• Defaults to Normal.

sample_set: Option<SampleSet>

Sample set that will be used if timing points do not override it.

• Defaults to Normal.

stack_leniency: Option<StackLeniency>

Multiplier for the threshold in time where hit objects placed close together stack.

• Defaults to 0.7.

mode: Option<Mode>

Game mode.

• Defaults to osu.

letterbox_in_breaks: Option<LetterboxInBreaks>

Whether or not breaks have a letterboxing effect.

• Defaults to false.

story_fire_in_front: Option<StoryFireInFront>

Deprecated.

• Defaults to true.

use_skin_sprites: Option<UseSkinSprites>

Whether or not the storyboard can use the user’s skin images.

• Defaults to false.

always_show_playfield: Option<AlwaysShowPlayfield>

Deprecated.

• Defaults to false.

overlay_position: Option<OverlayPosition>

Draw order of hit circle overlays compared to hit numbers.

• Defaults to NoChange.

skin_preference: Option<SkinPreference>

Preferred skin to use during gameplay.

epilepsy_warning: Option<EpilepsyWarning>

Whether or not a warning about flashing colours should be shown at the beginning of the map.

• Defaults to false.

countdown_offset: Option<CountdownOffset>

Time in beats that the countdown starts before the first hit object.

• Defaults to 0.

special_style: Option<SpecialStyle>

Whether or not the “N+1” style key layout is used for osu!mania.

• Defaults to false.

widescreen_storyboard: Option<WidescreenStoryboard>

Whether or not the storyboard allows widescreen viewing.

• Defaults to false.

samples_match_playback_rate: Option<SamplesMatchPlaybackRate>

Whether or not sound samples will change rate when playing with speed-changing mods.

• Defaults to false.

editor_bookmarks: Option<EditorBookmarks>

Deprecated.

editor_distance_spacing: Option<EditorDistanceSpacing>

Deprecated.

Implementations

impl General

pub fn new() -> Self

Creates a new instance, with all fields being None.

pub fn from_str(
    s: &str,
    version: Version
) -> Result<Option<General>, Error<ParseError>>

pub fn to_string(&self, _version: Version) -> Option<String>

Trait Implementations

impl Clone for General

fn clone(&self) -> General

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for General

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

Formats the value using the given formatter.

impl Default for General

fn default() -> Self

Returns the “default value” for a type.

impl Hash for General

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<General> for General

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for General

impl StructuralEq for General

impl StructuralPartialEq for General