Enum Pitch

#[repr(u8)]
pub enum Pitch {
    C = 0,
    CSharp = 1,
    D = 2,
    DSharp = 3,
    E = 4,
    F = 5,
    FSharp = 6,
    G = 7,
    GSharp = 8,
    A = 9,
    ASharp = 10,
    B = 11,
}

Pitch class that can be found on the chromatic scale.

Variants

C = 0

CSharp = 1

D = 2

DSharp = 3

E = 4

F = 5

FSharp = 6

G = 7

GSharp = 8

A = 9

ASharp = 10

B = 11

Implementations

impl Pitch

pub const fn natural(letter: Natural) -> Self

Returns the natural pitch for the given Natural.

use music_note::{Pitch, Natural};

let pitch = Pitch::natural(Natural::F);
assert_eq!(pitch, Pitch::F);

pub const fn from_byte(byte: u8) -> Self

pub const fn add_interval(self, interval: Interval) -> Self

pub const fn sub_interval(self, interval: Interval) -> Self

pub const fn into_byte(self) -> u8

pub const fn sub(self, rhs: Self) -> Interval

pub fn transpose(self, key: Pitch, to: Pitch) -> Pitch

Trait Implementations

impl Add<Interval> for Pitch

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, interval: Interval) -> Self

Performs the + operation.

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Degree for Pitch

type State = ()

fn state(self) -> Self::State

fn degree(self, _state: &mut Self::State, interval: Interval) -> Self

impl Display for Pitch

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

Formats the value using the given formatter.

impl From<MidiNote> for Pitch

fn from(midi: MidiNote) -> Self

Converts to this type from the input type.

impl From<Natural> for Pitch

fn from(letter: Natural) -> Self

Converts to this type from the input type.

impl<A> From<Note<A>> for Pitch

where A: Accidental,

fn from(note: Note<A>) -> Self

Converts to this type from the input type.

impl From<Pitch> for u8

fn from(pitch: Pitch) -> Self

Converts to this type from the input type.

impl From<u8> for Pitch

fn from(byte: u8) -> Self

Converts to this type from the input type.

impl Ord for Pitch

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Pitch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Pitch

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<Interval> for Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, interval: Interval) -> Self

Performs the - operation.

impl Sub for Pitch

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Interval

Performs the - operation.

impl Copy for Pitch

impl Eq for Pitch

impl StructuralPartialEq for Pitch