Struct Interval 

pub struct Interval { /* private fields */ }

A directed musical interval with diatonic spelling and chromatic size.

Implementations

impl Interval

pub fn from_name(name: impl Into<String>) -> Result<Self>

Parses an interval name such as "M3", "P5", or "-m6".

pub fn from_semitones(semitones: IntegerType) -> Result<Self>

Creates an implicit diatonic interval from a chromatic semitone count.

pub fn between_pitches(start: &Pitch, end: &Pitch) -> Result<Self>

Returns the directed interval from start to end.

pub fn between_notes(start: &Note, end: &Note) -> Result<Self>

Returns the directed interval from start to end.

pub fn semitones(&self) -> IntegerType

Returns the directed chromatic size in semitones.

pub fn direction(&self) -> IntervalDirection

Returns the directed interval direction.

pub fn name(&self) -> String

Returns the human-readable interval name, such as "Major Third".

pub fn generic_number(&self) -> IntegerType

Returns the simple or compound generic interval number.

pub fn is_implicit_diatonic(&self) -> bool

Returns true when the interval was inferred from semitones only.

pub fn inversion(&self) -> Result<Self>

Returns the complementary interval inversion.

pub fn reversed(&self) -> Result<Self>

Returns the same interval in the opposite direction.

pub fn transpose_pitch(&self, pitch: &Pitch) -> Result<Pitch>

Transposes a pitch by this interval.

pub fn transpose_note(&self, note: &Note) -> Result<Note>

Transposes a note by this interval.

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

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

Formats the value using the given formatter.

impl FromStr for Interval

type Err = Error

The associated error which can be returned from parsing.

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

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

impl TryFrom<&str> for Interval

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Interval

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for Interval

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IntegerType) -> Result<Self>

Performs the conversion.