ukebox 0.9.2

A ukulele chord toolbox in Rust
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

use std::{fmt, str::FromStr};

use clap::ValueEnum;

use crate::{Interval, Note, Semitones};

// Using clap's `value_enum` macro allows the specification of all Tuning
// variants as `possible_values` for the CLI `--tuning` option.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, ValueEnum)]
#[clap(rename_all = "UPPER")]
pub enum Tuning {
    C,
    D,
    G,
}

impl Tuning {
    pub fn get_semitones(self) -> Semitones {
        match self {
            Self::C => 0,
            Self::D => 2,
            Self::G => 7,
        }
    }

    pub fn get_interval(self) -> Interval {
        match self {
            Self::C => Interval::PerfectUnison,
            Self::D => Interval::MajorSecond,
            Self::G => Interval::PerfectFifth,
        }
    }

    pub fn roots(self) -> impl Iterator<Item = Note> + 'static {
        let interval = self.get_interval();

        ["G", "C", "E", "A"]
            .iter()
            .map(move |c| Note::from_str(c).unwrap() + interval)
    }
}

impl fmt::Display for Tuning {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            Self::C => "C",
            Self::D => "D",
            Self::G => "G",
        };

        write!(f, "{s}")
    }
}