Struct KeySignature 

pub struct KeySignature { /* private fields */ }

A key signature represented by the number of sharps.

Flats are represented as negative sharps, so B-flat major has -2.

Implementations

impl KeySignature

pub fn new(sharps: IntegerType) -> Self

Creates a key signature from a sharp count.

pub fn sharps(&self) -> IntegerType

Returns the number of sharps, with flats as negative values.

pub fn as_key(&self, mode: &str) -> Key

Converts this signature to a key in the given mode.

pub fn try_as_key(&self, mode: Option<&str>, tonic: Option<&str>) -> Result<Key>

Converts this signature to a key, optionally inferring mode from tonic.

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.