Struct Interval 

pub struct Interval { /* private fields */ }

Signed chromatic interval between two pitches.

semitones > 0 = ascending, < 0 = descending, 0 = unison.

Implementations

impl Interval

pub fn between(a: &Pitch, b: &Pitch) -> Self

Interval from pitch a to pitch b (positive = ascending).

pub fn semitones(&self) -> i16

Raw signed semitone count.

pub fn abs_semitones(&self) -> u16

Absolute (unsigned) semitone distance.

pub fn is_ascending(&self) -> bool

True when b was higher than a in Interval::between.

pub fn simple_number(&self) -> u8

Interval number within an octave (1 = unison, 2 = second … 8 = octave).

Compound intervals (> octave) return the simple equivalent (e.g. a ninth → 2).

pub fn quality(&self) -> IntervalQuality

Quality of the simple interval.

The tritone (6 semitones) is treated as Augmented (A4).

pub fn display(&self) -> String

Human-readable label: "P1", "M3", "P5", "m7", "A4", "P8" etc.

Octave equivalents (12, 24, …) are shown as "P8".

Trait Implementations

impl Clone for Interval

fn clone(&self) -> Interval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Interval

impl Debug for Interval

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Interval

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Interval

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Interval

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Interval