Struct musical_note::Octave

pub struct Octave { /* private fields */ }

Implementations

impl Octave

pub fn new(octave: u8) -> Self

octave number should be raw: like

let middle_c = 60u8;
let octave = Octave::new(middle_c/12);

pub fn raw(&self) -> u8

pub fn as_midi(&self) -> i8

can be negative. Here middle-c considered as C3. So, function return would be in range of -2..9

pub fn from_midi(midi: u8) -> Self

pub fn split_midi(midi: u8) -> (u8, Self)

Get note index (C=0, D=2, D#=3, B=11) and octave.

pub fn apply_to_midi_note(&self, note_idx: u8) -> u8

Return raw midi byte.

Trait Implementations

impl Clone for Octave

fn clone(&self) -> Octave

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Octave

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

Formats the value using the given formatter.

impl From<&str> for Octave

fn from(value: &str) -> Self

Converts to this type from the input type.

impl PartialEq<Octave> for Octave

fn eq(&self, other: &Octave) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Octave> for Octave

fn partial_cmp(&self, other: &Octave) -> 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 Copy for Octave

impl Eq for Octave

impl StructuralEq for Octave

impl StructuralPartialEq for Octave