Struct Key 

pub struct Key {
    pub tonic: u8,
    pub mode: Mode,
}

A tonic pitch class and a mode.

Fields

tonic: u8

The tonic, 0 (C) to 11 (B).

mode: Mode

Major or minor.

Implementations

impl Key

pub fn new(tonic: u8, mode: Mode) -> Self

A key; the tonic is taken modulo 12.

pub fn relative(self) -> Self

The relative key: the minor a major sixth up, the major a minor third up.

pub fn parallel(self) -> Self

The parallel key: the same tonic in the other mode.

pub fn spelling(self) -> Spelling

Sharps or flats for display: flats for F, Bb, Eb, Ab and Db major and for D, G, C, F, Bb and Eb minor; sharps otherwise.

pub fn camelot(self) -> Camelot

The Camelot code: the number of the major tonic t is the n with 7 * (n - 8) = t modulo 12; minor keys take the number of their relative major.

pub fn open_key(self) -> OpenKey

The Open Key code: number (n + 4) mod 12 + 1 of the Camelot number n.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Key

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Key

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Key