osu-file-parser 1.1.0

A crate to parse an osu! beatmap file
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use std::num::ParseIntError;

use thiserror::Error;

use crate::helper::{macros::unreachable_err_impl, ParseZeroOneBoolError};

#[derive(Debug, Error)]
#[non_exhaustive]
/// Error used when there was a problem parsing the `General` section.
pub enum ParseError {
    /// A Field in `General` failed to parse as a `Integer`.
    #[error(transparent)]
    ParseIntError(#[from] ParseIntError),
    /// A field in `General` failed to parse as a `bool` from an `Integer`.
    #[error(transparent)]
    ParseZeroOneBoolError(#[from] ParseZeroOneBoolError),
    /// A field in `General` failed to parse as a `CountdownSpeed`.
    #[error(transparent)]
    ParseCountdownSpeedError(#[from] ParseCountdownSpeedError),
    /// A field in `General` failed to parse as a `GameMode`.
    #[error(transparent)]
    ParseGameModeError(#[from] ParseGameModeError),
    #[error(transparent)]
    ParseSampleSetError(#[from] ParseSampleSetError),
    #[error(transparent)]
    ParseOverlayPositionError(#[from] ParseOverlayPositionError),
    /// When the line isn't in a `key: value` format.
    #[error("Invalid colon set, expected format of `key: value`")]
    InvalidColonSet,
    /// Invalid key name was used.
    #[error("The key doesn't exist in `General`")]
    InvalidKey,
    /// Duplicate field in `General` were found.
    #[error("Duplicate field were found in `General`")]
    DuplicateField,
    /// Field doesn't exist in version.
    #[error("Field doesn't exist in version")]
    InvalidVersion,
    /// Invalid comma list, expected format of `key: value, value, value, ...`
    #[error("Invalid comma list, expected format of `key: value, value, value, ...`")]
    InvalidCommaList,
}

unreachable_err_impl!(ParseError);

/// Error used when there's an error parsing the string as enum.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ParseGameModeError {
    /// Error when the `GameMode` is not a valid enum.
    #[error("Unknown `GameMode` variant")]
    UnknownVariant,
    /// Error trying to parse the `str` into an `Integer`.
    #[error(transparent)]
    ParseError(#[from] ParseIntError),
}

/// Error used when there's an error parsing the string as enum
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ParseCountdownSpeedError {
    /// The integer value is an unknown `CountdownSpeed` type.
    #[error("Unknown `CountdownSpeed` variant")]
    UnknownVariant,
    /// There was a problem converting from `str` to an `Integer`.
    #[error("There was a problem parsing the `str` as an `Integer`")]
    ParseError(#[from] ParseIntError),
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ParseOverlayPositionError {
    #[error("Unknown `OverlayPosition` variant")]
    UnknownVariant,
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ParseSampleSetError {
    #[error("Unknown `SampleSet` variant")]
    UnknownVariant,
}