Enum Octave 

pub enum Octave {
    OctM2,
    OctM1,
    Oct0,
    Oct1,
    Oct2,
    Oct3,
    Oct4,
    Oct5,
    Oct6,
    Oct7,
    Oct8,
}

Musical octave number.

Represents the octave of a pitch, ranging from -2 to 8. Octave 3 contains middle C (C3 = MIDI note 60).

Examples

let middle_octave = Octave::Oct3;  // Contains middle C (MIDI note 60)
let low_octave = Octave::Oct0;
let high_octave = Octave::Oct8;

Variants

OctM2

Octave -2

OctM1

Octave -1

Oct0

Octave 0

Oct1

Octave 1

Oct2

Octave 2

Oct3

Octave 3

Oct4

Octave 4

Oct5

Octave 5

Oct6

Octave 6

Oct7

Octave 7

Oct8

Octave 8

Implementations

impl Octave

pub const ALL: &'static [Octave]

Array of all valid octaves.

pub const MIN_VALUE: Octave = Octave::OctM2

Minimum octave constant.

pub const MAX_VALUE: Octave = Octave::Oct8

Maximum octave constant.

pub const BIAS_VALUE: i32 = 2i32

Bias value for internal calculations.

pub const fn value_of(value: i32) -> Result<Octave, OctaveError>

Creates an octave from a numeric value (-2 to 8).

Arguments

• value - The octave number (-2 to 8).

Returns

• Ok(Octave) - The octave.
• Err(OctaveError) - If the value is out of range.

pub const fn from_score_offset(idx: i32) -> Result<Octave, OctaveError>

Creates an octave from a score offset index.

Arguments

• idx - The score offset index (0-10).

Returns

• Ok(Octave) - The octave.
• Err(OctaveError) - If the index is out of range.

pub const fn offset(self) -> i32

Returns the score offset for this octave.

pub const fn value(self) -> i32

Returns the numeric value of this octave (-2 to 8).

Trait Implementations

impl Add for Octave

type Output = Octave

The resulting type after applying the + operator.

fn add(self, other: Self) -> Octave

Performs the + operation.

impl AddAssign<i32> for Octave

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

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<'de> Deserialize<'de> for Octave

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Octave

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SubAssign<i32> for Octave

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

impl Copy for Octave

impl Eq for Octave

impl StructuralPartialEq for Octave