Struct Octave

pub struct Octave(/* private fields */);

Identifies the octave for a Key. Values range from -1 to 9.

Example

let octave = Octave::new(12); // clamps to 9

assert_eq!(octave.value(), 9);

let key = octave.with_note(Note::C);


assert_eq!(key.octave().value(), 9);
assert_eq!(key.note(), Note::C);

Implementations

impl Octave

pub fn from_data_byte(key: &DataByte) -> Self

Identify an octave from a key byte.

pub const fn new(octave: i8) -> Self

Should be a value between [-1, 9]. Clamps between these two values.

pub const fn value(&self) -> i8

The octave, from [-1,9]

pub fn with_note(self, note: Note) -> Key

Create a Key given this octave and a provided Note

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 Display for Octave

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

Formats the value using the given formatter.

impl PartialEq for Octave

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

impl StructuralPartialEq for Octave