Struct Interval 

pub struct Interval {
    pub semitones: i32,
}

A pitch interval measured in semitones.

Positive values are ascending and negative values descending. The signed distance is preserved; use Interval::class to collapse to an interval class.

Fields

semitones: i32

The signed distance in semitones.

Implementations

impl Interval

pub const UNISON: Self

The perfect unison (0 semitones).

pub const MINOR_3: Self

The minor third (3 semitones).

pub const MAJOR_3: Self

The major third (4 semitones).

pub const PERFECT_5: Self

The perfect fifth (7 semitones).

pub const TRITONE: Self

The tritone (6 semitones).

pub const MAJOR_7: Self

The major seventh (11 semitones).

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

Returns the directed interval from a to b.

pub fn class(self) -> u8

Returns the interval class (0..=6) of this interval, the smaller of the ascending and descending mod-12 distances.

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 Eq for Interval

impl FromStr for Interval

type Err = PitchError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Interval

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 Interval

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Interval