# osu-file-parser

A crate to parse an osu! beatmap file.

How to use

```rust use osufileparser::*;

let osufilestr = includestr!("./tests/osufiles/files/acidrain.osu"); // parse the .osu file let mut osufile = osufilestr.parse::().unwrap();

let osbstr = includestr!("./tests/osufiles/files/acidrain.osb"); // .osb file can also be parsed and appended to the OsuFile instance osufile.appendosb(osb_str).unwrap();

// you can use assert_eq_osu_str to assert that the parsed .osu file is equal to the original .osu file asserteqosustr(&osufile.tostring(), osufilestr); asserteqosustr(&osufile.osbtostring().unwrap(), osbstr); ```

General information

Alternative traits

• Most of the types in the crate uses the VersionedToString, VersionedFromStr and VersionedDefault traits as replacements for the Display, FromStr and Default traits.
• Those traits take an extra version parameter to choose what version output to use.
• If the type doesn't exist in certain versions, the output will be None.

Errors

• Structs that takes lines of string as input can return errors containing information of where the error occurred and what the error was.
• The error type is wrapped in Error in those cases.
• Error has methods that tells you where the error happened in the input string and what the error was.