Struct Key 

pub struct Key { /* private fields */ }

A tonal key with a tonic pitch and mode.

Implementations

impl Key

pub fn from_tonic_mode<'a, M>(tonic: &str, mode: M) -> Result<Self>

where M: Into<Option<&'a str>>,

Builds a key from a tonic and mode.

Pass a mode string such as "major", "minor", "dorian", or None::<&str> to infer major/minor from tonic case.

pub fn from_tonic(tonic: &str) -> Result<Self>

Builds a key and infers major/minor from tonic case.

pub fn tonic(&self) -> Pitch

Returns a cloned tonic pitch.

pub fn tonic_pitch(&self) -> &Pitch

Returns a borrowed tonic pitch.

pub fn mode(&self) -> &str

Returns the key mode.

pub fn sharps(&self) -> IntegerType

Returns the number of sharps in the key signature.

pub fn key_signature(&self) -> KeySignature

Returns the matching key signature.

pub fn scale(&self) -> DiatonicScale

Returns the diatonic scale for this key.

pub fn pitch_from_degree(&self, degree: usize) -> Result<Pitch>

Returns the pitch at a one-based scale degree.

pub fn pitches(&self) -> Result<Vec<Pitch>>

Returns scale pitches from degree 1 through the octave.

pub fn triad_from_degree(&self, degree: usize) -> Result<Chord>

Builds the diatonic triad on a one-based degree.

pub fn seventh_chord_from_degree(&self, degree: usize) -> Result<Chord>

Builds the diatonic seventh chord on a one-based degree.

pub fn harmonized_triads(&self) -> Result<Vec<Chord>>

Returns all seven diatonic triads.

pub fn harmonized_sevenths(&self) -> Result<Vec<Chord>>

Returns all seven diatonic seventh chords.

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

Returns the relative major or minor key when applicable.

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

Returns the parallel major or minor key when applicable.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl FromStr for Key

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 Key

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 Key

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.