Struct ChordParser 

pub struct ChordParser { /* private fields */ }

The chord parser used for parsing chord signatures into abstract representations defined in chord module

Implementations

impl ChordParser

pub fn new() -> Self

Creates a new instance of ChordParser. Use ChordParser::parse(&str) to execute parsing on an input.

pub fn from_str(s: &str) -> ChordParseResult

Parse a chord signature directly from the input. Shorter than having to create an instance via new function.

Examples

use chord_parser::*;
 
let result = ChordParser::from_str("C#7b9"); // Parse directly from the input
 
match result {
    ChordParseResult::Success(chord) => (),
    ChordParseResult::Failure(error_kind) => (),
}

pub fn parse(&mut self, s: &str) -> ChordParseResult

Parse a chord signature from a string slice.

Examples

use chord_parser::*;
 
let mut parser = ChordParser::new();
 
let result = parser.parse("C#7b9"); // Parse from the input
 
match result {
    ChordParseResult::Success(chord) => (),
    ChordParseResult::Failure(error_kind) => (),
}

pub fn try_parse_interval(&mut self, s: &str) -> Option<AlteredInterval>

Tries to parse the interval from a string slice.

Examples

use chord_parser::*;
 
let mut parser = ChordParser::new();
 
let result = parser.try_parse_interval("13");
 
match result {
    Some(interval) => println!("Interval is: {:?}", interval),
    None => panic!("Expected success!"),
}

pub fn try_parse_note_alter( &mut self, s: &str, require_accidental: bool, ) -> Option<ChordNoteAlter>

Tries to parse the note alteration from a string slice.

Examples

use chord_parser::*;
 
let mut parser = ChordParser::new();
 
let result = parser.try_parse_note_alter("b13", true);
 
match result {
    Some(alter) => println!("Alteration is: {:?}", alter),
    None => panic!("Forgot an accidental?"),
}