ukebox 0.4.0

A ukulele chord finder 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

use crate::note::Interval;
use crate::note::Semitones;
use structopt::clap::arg_enum;

// Using clap's `arg_enum` macro allows the specification of all Tuning
// variants as `possible_values` for the CLI `--tuning` option.
arg_enum! {
    #[derive(Debug, Clone, Copy)]
    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,
        }
    }

    /// Get the width of the space that we need to print the name
    /// of the root notes (the names of the strings) for this tuning.
    pub fn get_root_width(self) -> usize {
        match self {
            Self::C => 1,
            Self::D => 2, // We need 2 here because of F#.
            Self::G => 1,
        }
    }
}