Enum tonality::tpc::Tpc

pub enum Tpc {
    Fbb,
    Cbb,
    Gbb,
    Dbb,
    Abb,
    Ebb,
    Bbb,
    Fb,
    Cb,
    Gb,
    Db,
    Ab,
    Eb,
    Bb,
    F,
    C,
    G,
    D,
    A,
    E,
    B,
    Fs,
    Cs,
    Gs,
    Ds,
    As,
    Es,
    Bs,
    Fss,
    Css,
    Gss,
    Dss,
    Ass,
    Ess,
    Bss,
}

Tonal pitch class

Has variants for all pitch classes with double or single flats, natural, double or single sharps.

Note that the "s" and "ss" suffixes mean sharp and double sharp. Should not be confused with the names of flat notes, which in some languages use the -s suffix.

Variants

Fbb

Cbb

Gbb

Dbb

Abb

Ebb

Bbb

Fb

Cb

Gb

Db

Ab

Eb

Bb

F

C

G

D

A

E

B

Fs

Cs

Gs

Ds

As

Es

Bs

Fss

Css

Gss

Dss

Ass

Ess

Bss

Implementations

impl Tpc

pub fn alteration(&self, key: Key) -> Alteration

The number of semitones by which the tpc is altered with respect to the key

Example

// C natural is not altered in the key of A flat
assert_eq!(0, Tpc::C.alteration(Key::Ab));
// A major has C sharp, so a C natural is one semitone flat
assert_eq!(-1, Tpc::C.alteration(Key::A));
// Db major has A flat, so an A sharp is two semitones sharp
assert_eq!(2, Tpc::As.alteration(Key::Db));

pub fn altered_step(&self, key: Option<Key>) -> (Step, Option<Accidental>)

Find the appropriate accidental for the Tpc in a key.

If no key is given, default to C major with no fixed accidentals

Example

let tpc = Tpc::C;
let key: Option<Key> = None;
assert_eq!((Step::C, None), tpc.altered_step(key));
 
let key: Option<Key> = Some(Key::A);
assert_eq!((Step::C, Some(Accidental::Natural)), tpc.altered_step(key));
 
let tpc = Tpc::Fss;
let key: Option<Key> = None;
assert_eq!((Step::F, Some(Accidental::DblSharp)), tpc.altered_step(key));

pub fn alter(&self, by: Alteration) -> Option<Tpc>

Adjust alteration while maintaining the step value

Returns None if the alteration would be sharper than double sharp or flatter than double flat

Trait Implementations

impl Clone for Tpc

fn clone(&self) -> Tpc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tpc

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

Formats the value using the given formatter.

impl<'_> From<&'_ Tpc> for Step

fn from(tpc: &Tpc) -> Self

Performs the conversion.

impl FromPrimitive for Tpc

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl PartialEq<Tpc> for Tpc

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for Tpc

impl ToPrimitive for Tpc

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. If the value cannot be represented by an f32, then None is returned.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. If the value cannot be represented by an f64, then None is returned.