Enum music_note::Pitch

#[repr(u8)]
pub enum Pitch {
    C,
    CSharp,
    D,
    DSharp,
    E,
    F,
    FSharp,
    G,
    GSharp,
    A,
    ASharp,
    B,
}

Pitch class that can be found on the chromatic scale.

Variants

C

CSharp

D

DSharp

E

F

FSharp

G

GSharp

A

ASharp

B

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 copy 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

fn next_degree(self, 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 From<Note> for Pitch

fn from(note: Note) -> 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 FromIterator<Pitch> for Set<Pitch, u16>

fn from_iter<T: IntoIterator<Item = Pitch>>(iter: T) -> Self

Creates a value from an iterator.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Pitch> for Pitch

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

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

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

This method tests for !=.

impl PartialOrd<Pitch> 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

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

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

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

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

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

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 Sub<Pitch> 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 StructuralEq for Pitch

impl StructuralPartialEq for Pitch