Enum pitch_calc::letter::Letter

pub enum Letter {
    C,
    Csh,
    Db,
    D,
    Dsh,
    Eb,
    E,
    F,
    Fsh,
    Gb,
    G,
    Gsh,
    Ab,
    A,
    Ash,
    Bb,
    B,
}

The letter representation for each step in the 12-tone, equal temperament, chromatic scale.

Variants

C

Csh

Db

D

Dsh

Eb

E

F

Fsh

Gb

G

Gsh

Ab

A

Ash

Bb

B

Methods

impl Letter

pub fn is_black_key(self) -> bool

Returns whether or not the note would be a black key on a standard piano or keyboard.

Trait Implementations

impl Add<Letter> for Letter

type Output = Letter

The resulting type after applying the + operator.

fn add(self, rhs: Letter) -> Letter

Performs the + operation.

impl<T: Int> Add<T> for Letter

type Output = Letter

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Letter

Performs the + operation.

impl Clone for Letter

fn clone(&self) -> Letter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Letter

impl Debug for Letter

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

Formats the value using the given formatter.

impl Eq for Letter

impl FromPrimitive for Letter

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Ord for Letter

fn cmp(&self, other: &Letter) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Letter> for Letter

fn eq(&self, other: &Letter) -> 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 PartialOrd<Letter> for Letter

fn partial_cmp(&self, other: &Letter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rand for Letter

fn rand<R: Rng>(rng: &mut R) -> Letter

Generates a random instance of this type using the specified source of randomness.

impl Sub<Letter> for Letter

type Output = Letter

The resulting type after applying the - operator.

fn sub(self, rhs: Letter) -> Letter

Performs the - operation.

impl<T: Int> Sub<T> for Letter

type Output = Letter

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Letter

Performs the - operation.

impl ToPrimitive for Letter

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

Converts the value of self to an i64.

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

Converts the value of self to an u64.

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

Converts the value of self to an isize.

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

Converts the value of self to an i8.

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

Converts the value of self to an i16.

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

Converts the value of self to an i32.

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

Converts the value of self to a usize.

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

Converts the value of self to an u8.

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

Converts the value of self to an u16.

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

Converts the value of self to an u32.

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

Converts the value of self to an f32.

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

Converts the value of self to an f64.