Struct osu_file_parser::osu_file::OsuFile

#[non_exhaustive]
pub struct OsuFile {
    pub version: Version,
    pub general: Option<General>,
    pub editor: Option<Editor>,
    pub osb: Option<Osb>,
    pub metadata: Option<Metadata>,
    pub difficulty: Option<Difficulty>,
    pub events: Option<Events>,
    pub timing_points: Option<TimingPoints>,
    pub colours: Option<Colours>,
    pub hitobjects: Option<HitObjects>,
}

An .osu file represented as a struct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: Version

Version of the file format.

general: Option<General>

General information about the beatmap.

• key: value pairs.

editor: Option<Editor>

Saved settings for the beatmap editor.

• key: value pairs.

osb: Option<Osb>

Contents of an .osb storyboard file.

metadata: Option<Metadata>

Information used to identify the beatmap.

• key:value pairs.

difficulty: Option<Difficulty>

Difficulty settings.

• key:value pairs.

events: Option<Events>

Beatmap and storyboard graphic events. Comma-separated lists.

timing_points: Option<TimingPoints>

Timing and control points. Comma-separated lists.

colours: Option<Colours>

Combo and skin colours. key : value pairs.

hitobjects: Option<HitObjects>

Hit objects. Comma-separated lists.

Implementations

impl OsuFile

pub fn new(version: Version) -> Self

New OsuFile with no data.

pub fn append_osb(&mut self, s: &str) -> Result<(), Error<ParseError>>

Appends .osb file.

pub fn osb_to_string(&self) -> Option<String>

Generates .osb file contents.

pub fn default(version: Version) -> OsuFile

Trait Implementations

impl Clone for OsuFile

fn clone(&self) -> OsuFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OsuFile

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

Formats the value using the given formatter.

impl Display for OsuFile

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

Formats the value using the given formatter.

impl FromStr for OsuFile

type Err = Error<ParseError>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for OsuFile

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<OsuFile> for OsuFile

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

impl StructuralEq for OsuFile

impl StructuralPartialEq for OsuFile