lilypond 0.1.1

A Rust wrapper and types for GNU LilyPond
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Abstractions for specifying the rhythm of notes

/// Possible lengths
#[derive(PartialEq, Debug)]
pub enum Length {
    Whole,
    Half,
    Quarter,
    Eighth,
    Sixteenth,
    ThirtySecond,
    SixtyFourth,
    OneTwentyEighth,
}

impl Default for Length {
    fn default() -> Self {
        Length::Quarter
    }
}

/// Type of duration
#[derive(PartialEq, Debug)]
pub enum NoteDurationType {
    Note,
    Rest,
}

impl Default for NoteDurationType {
    fn default() -> Self {
        NoteDurationType::Note
    }
}

/// A duration for a note
#[derive(PartialEq, Debug)]
pub struct NoteDuration {
    /// Length e.g. Quarter, Half, or Whole
    pub length: Length,
    /// Whether or not the note is dotted
    pub dotted: bool,
    /// The duration type (Note or Rest)
    pub duration_type: NoteDurationType,
}

impl NoteDuration {
    /// Construct a new duration
    ///
    /// This will initialize with default values.
    ///
    /// # Usage:
    ///
    /// ```
    /// use lilypond::notation::rhythm::{NoteDuration, Length, NoteDurationType};
    ///
    /// let duration = NoteDuration::new();
    ///
    /// assert_eq!(duration.length, Length::Quarter);
    /// assert_eq!(duration.dotted, false);
    /// assert_eq!(duration.duration_type, NoteDurationType::Note);
    /// ```
    pub fn new() -> NoteDuration {
        NoteDuration {
            length: Default::default(),
            dotted: false,
            duration_type: Default::default(),
        }
    }
    /// Set length for a duration
    ///
    /// # Usage:
    ///
    /// ```
    ///
    /// use lilypond::notation::rhythm::{NoteDuration, Length};
    ///
    /// let mut  duration = NoteDuration::new();
    /// duration.length(Length::Sixteenth);
    ///
    /// assert_eq!(Length::Sixteenth, duration.length)
    /// ```
    pub fn length(&mut self, length: Length) {
        self.length = length;
    }
    /// Set whether or not a duration is dotted
    ///
    /// # Usage:
    ///
    /// ```
    ///
    /// use lilypond::notation::rhythm::NoteDuration;
    ///
    /// let mut  duration = NoteDuration::new();
    /// duration.dotted(true);
    ///
    /// assert_eq!(true, duration.dotted)
    /// ```
    pub fn dotted(&mut self, is_dotted: bool) {
        self.dotted = is_dotted;
    }
    /// Set duration type
    ///
    /// # Usage:
    ///
    /// ```
    ///
    /// use lilypond::notation::rhythm::{NoteDuration, NoteDurationType};
    ///
    /// let mut  duration = NoteDuration::new();
    /// duration.duration_type(NoteDurationType::Rest);
    ///
    /// assert_eq!(NoteDurationType::Rest, duration.duration_type)
    /// ```
    pub fn duration_type(&mut self, duration_type: NoteDurationType) {
        self.duration_type = duration_type;
    }
}