musicxml 1.1.2

MusicXML parsing, manipulation, and export library
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use super::Accord;
use crate::datatypes::Id;
use alloc::{string::String, vec::Vec};
use musicxml_internal::*;
use musicxml_macros::*;

/// Attributes pertaining to the [Scordatura] element.
#[derive(Debug, Default, PartialEq, Eq, AttributeDeserialize, AttributeSerialize)]
pub struct ScordaturaAttributes {
  /// Specifies an ID that is unique to the entire document.
  pub id: Option<Id>,
}

/// [Scordatura] string tunings are represented by a series of [Accord] elements, similar to the [StaffTuning][super::StaffTuning] elements.
///
/// ![Scordatura](https://hedgetechllc.github.io/musicxml/musicxml/elements/scordatura.png)
///
/// Strings are numbered from high to low.
#[derive(Debug, PartialEq, Eq, ElementDeserialize, ElementSerialize)]
pub struct Scordatura {
  /// Element-specific attributes
  pub attributes: ScordaturaAttributes,
  /// Element-specific content
  pub content: Vec<Accord>,
}

#[cfg(test)]
mod scordatura_tests {
  use crate::datatypes::{Octave, Semitones, Step, StringNumber};
  use crate::elements::*;
  use crate::parser::{parse_from_xml_str, parse_to_xml_str};

  #[test]
  fn serialize_valid1() {
    let test = Scordatura {
      attributes: ScordaturaAttributes::default(),
      content: vec![
        Accord {
          attributes: AccordAttributes {
            string: Some(StringNumber(1)),
          },
          content: AccordContents {
            tuning_step: TuningStep {
              attributes: (),
              content: Step::D,
            },
            tuning_alter: Some(TuningAlter {
              attributes: (),
              content: Semitones(-1),
            }),
            tuning_octave: TuningOctave {
              attributes: (),
              content: Octave(4),
            },
          },
        },
        Accord {
          attributes: AccordAttributes {
            string: Some(StringNumber(2)),
          },
          content: AccordContents {
            tuning_step: TuningStep {
              attributes: (),
              content: Step::E,
            },
            tuning_alter: Some(TuningAlter {
              attributes: (),
              content: Semitones(4),
            }),
            tuning_octave: TuningOctave {
              attributes: (),
              content: Octave(3),
            },
          },
        },
      ],
    };
    let expected = "<scordatura>
  <accord string=\"1\">
    <tuning-step>D</tuning-step>
    <tuning-alter>-1</tuning-alter>
    <tuning-octave>4</tuning-octave>
  </accord>
  <accord string=\"2\">
    <tuning-step>E</tuning-step>
    <tuning-alter>4</tuning-alter>
    <tuning-octave>3</tuning-octave>
  </accord>
</scordatura>";
    let result = parse_to_xml_str(&test, true);
    assert_eq!(result, expected);
  }

  #[test]
  fn deserialize_valid1() {
    let result = parse_from_xml_str::<Scordatura>(
      "
    <scordatura>
      <accord string=\"1\">
        <tuning-step>D</tuning-step>
        <tuning-alter>-1</tuning-alter>
        <tuning-octave>4</tuning-octave>
      </accord>
      <accord string=\"2\">
        <tuning-step>E</tuning-step>
        <tuning-alter>4</tuning-alter>
        <tuning-octave>3</tuning-octave>
      </accord>
    </scordatura>",
    );
    assert!(result.is_ok());
    assert_eq!(
      result.unwrap(),
      Scordatura {
        attributes: ScordaturaAttributes::default(),
        content: vec![
          Accord {
            attributes: AccordAttributes {
              string: Some(StringNumber(1)),
            },
            content: AccordContents {
              tuning_step: TuningStep {
                attributes: (),
                content: Step::D
              },
              tuning_alter: Some(TuningAlter {
                attributes: (),
                content: Semitones(-1)
              }),
              tuning_octave: TuningOctave {
                attributes: (),
                content: Octave(4)
              },
            }
          },
          Accord {
            attributes: AccordAttributes {
              string: Some(StringNumber(2)),
            },
            content: AccordContents {
              tuning_step: TuningStep {
                attributes: (),
                content: Step::E
              },
              tuning_alter: Some(TuningAlter {
                attributes: (),
                content: Semitones(4)
              }),
              tuning_octave: TuningOctave {
                attributes: (),
                content: Octave(3)
              },
            }
          },
        ]
      }
    );
  }
}