rstmt-core 0.1.0

the core modules for the rstmt framework
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

/*
    Appellation: classifiers <module>
    Created At: 2025.12.21:09:08:08
    Contrib: @FL03
*/
use crate::pitch::Accidental;
use rstmt_traits::PitchMod;

/// The [`RawPitchClass`] is a sealed trait used to define raw pitch class types.
pub trait RawPitchClass
where
    Self: Send
        + Sync
        + AsRef<str>
        + AsRef<isize>
        + PartialEq<isize>
        + PartialEq<str>
        + core::borrow::Borrow<isize>
        + core::fmt::Debug
        + core::fmt::Display,
{
    type Tag: Accidental;

    private! {}

    fn new() -> Self
    where
        Self: Sized;
    /// returns the name of the pitch class; i.e., "C", "D", "E", etc.
    fn name(&self) -> &str;
    /// returns the value associated with the pitch class
    fn index(&self) -> isize;
}

/// [`PitchClassRepr`] extends [`RawPitchClass`], providing various initialization routines,
/// defaults, and other methods useful for pitch class representations.
pub trait PitchClassRepr: RawPitchClass
where
    Self: Default + core::str::FromStr<Err = crate::error::Error> + TryFrom<isize>,
{
    const IDX: isize;

    /// returns true if the given value corresponds to this pitch class
    fn is(value: isize) -> bool
    where
        Self: Sized,
    {
        value.pmod() == Self::IDX
    }
}