chordpro 0.3.1

A Chordpro parser for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! # Chordpro
//! This crate is a chordpro parser. Chordpro is a simple text format for
//! the notation of lyrics with chords. Although initially intended for
//! guitarists, it can be used for all kinds of musical purposes.
//! Specification of the format can be found in the official website:
//! [https://www.chordpro.org/](https://www.chordpro.org/)
//! 
//! To build a `Song` from a chordpro file:
//! ```
//! # use chordpro::Song;
//! # use std::str::FromStr;
//! 
//! let song = Song::from_str(r##"
//!     {title: Song Title}"
//!     {artist: The Artist}
//!     
//!     This is the first verse.
//!     You can specify chords using brackets.
//!     This is a [G]chord
//! 
//!     {soc}
//!     This is the chorus of the song
//!     [Em]You can also add some chords
//!     {eoc}
//! "##).unwrap();
//! ```

#![crate_name = "chordpro"]

extern crate pest;
#[macro_use] extern crate pest_derive;
extern crate serde;
extern crate num_traits;
#[macro_use] extern crate num_derive;

pub mod chords;
pub mod song;
pub mod iterators;
pub mod songparse;
pub mod transpose;
pub mod format;

pub use {
    chords::{
        Chord,
        Note
    },
    song::{
        Song,
        Section,
        Paragraph,
        Line,
        Chunk
    },
    iterators::{
        SectionIterator,
        SectionMutIterator,
    },
    format::{
        latin, Latin
    }
};