Struct KeySignature 

pub struct KeySignature {
    pub tonic: Pitch,
    pub mode: Option<Mode>,
}

A key signature.

Fields

tonic: Pitch

The tonic of the key signature.

mode: Option<Mode>

The mode of the key signature.

Implementations

impl KeySignature

pub fn new(tonic: Pitch) -> Self

Create a new key signature.

pub fn new_with_mode(tonic: Pitch, mode: Option<Mode>) -> Self

Create a new key signature with a mode.

pub fn get_preferred_spelling(&self, pitch: Pitch) -> PitchSymbol

Trait Implementations

impl Clone for KeySignature

fn clone(&self) -> KeySignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeySignature

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

Formats the value using the given formatter.