Struct KeyParser 

pub struct KeyParser { /* private fields */ }

Implementations

impl KeyParser

pub fn try_from_string<'a>(s: &str) -> Result<Self, &'a str>

Try parsing a Key from string.

Example:

use libkeynotation::{Key, KeyParser, NotationType};
let parsed_key = KeyParser::try_from_string("G#m");
assert_eq!(parsed_key.is_ok(), true);
let parsed_key = parsed_key.unwrap();
assert_eq!(parsed_key.key(), Key::GSharpMinor);
assert_eq!(parsed_key.notation_type(), NotationType::Traditional);

pub fn notation_type(&self) -> NotationType

You want to know what notation representation the parser detected?

pub fn key(&self) -> Key