harmonia 0.1.0

Instrument-agnostic music theory primitives: pitch classes, intervals, scales, chords, keys, and progressions.
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

//! Parser error type shared by every [`FromStr`](std::str::FromStr)
//! implementation in the crate.

use std::fmt;

/// Error returned when parsing a music-theory value (a note, chord, scale,
/// etc.) fails. The message is human-readable but its exact text is not
/// part of the stable API.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ParseError {
    message: String,
}

impl ParseError {
    /// Construct a [`ParseError`] from an arbitrary message.
    /// Crate-internal — external callers receive `ParseError` as the
    /// `Err` variant of `FromStr` impls.
    pub(crate) fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
        }
    }
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.message)
    }
}

impl std::error::Error for ParseError {}