Struct Octave 

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

A note’s octave in MIDI.

Implementations

impl Octave

pub const NEGATIVE_ONE: Self

Octave -1

pub const ZERO: Self

Octave 0

pub const ONE: Self

Octave 1

pub const TWO: Self

Octave 2

pub const THREE: Self

Octave 3

pub const FOUR: Self

Octave 4

pub const FIVE: Self

Octave 5

pub const SIX: Self

Octave 6

pub const SEVEN: Self

Octave 7

pub const EIGHT: Self

Octave 8

pub fn new_unchecked(num: i8) -> Self

pub const fn from_midi(note: MidiNote) -> Self

Return the Octave of the given midinote.

pub const fn into_i8(self) -> i8

Return the i8 representation of self.

Trait Implementations

impl Clone for Octave

fn clone(&self) -> Octave

Returns a duplicate 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 Ord for Octave

fn cmp(&self, other: &Octave) -> 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 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 PartialOrd 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

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

impl Eq for Octave

impl StructuralPartialEq for Octave