Event

Struct Event 

Source
pub struct Event {
Show 13 fields pub duration: Option<NoteValue>, pub id: Option<Id>, pub lyrics: Option<EventLyrics>, pub markings: Option<EventMarkings>, pub measure: Option<bool>, pub notes: Vec<EventNotesItem>, pub orient: Option<Orientation>, pub rest: Option<EventRest>, pub slurs: Vec<EventSlursItem>, pub smufl_font: Option<SmuflFont>, pub staff: Option<StaffNumber>, pub stem_direction: Option<StemDirection>, pub type_: Option<String>,
}
Expand description

Event

JSON schema
{
 "type": "object",
 "properties": {
   "duration": {
     "$ref": "#/$defs/note-value"
   },
   "id": {
     "$ref": "#/$defs/id"
   },
   "lyrics": {
     "type": "object",
     "properties": {
       "lines": {
         "type": "object",
         "patternProperties": {
           "^.*$": {
             "type": "object",
             "required": [
               "text"
             ],
             "properties": {
               "text": {
                 "$ref": "#/$defs/string"
               },
               "type": {
                 "type": "string",
                 "enum": [
                   "start",
                   "middle",
                   "end",
                   "whole"
                 ]
               }
             },
             "additionalProperties": false
           }
         },
         "additionalProperties": false
       }
     },
     "additionalProperties": false
   },
   "markings": {
     "type": "object",
     "properties": {
       "accent": {
         "type": "object",
         "properties": {
           "pointing": {
             "$ref": "#/$defs/up-or-down"
           }
         },
         "additionalProperties": false
       },
       "breath": {
         "type": "object",
         "properties": {
           "symbol": {
             "type": "string"
           }
         },
         "additionalProperties": false
       },
       "softAccent": {
         "type": "object",
         "additionalProperties": false
       },
       "spiccato": {
         "type": "object",
         "additionalProperties": false
       },
       "staccatissimo": {
         "type": "object",
         "additionalProperties": false
       },
       "staccato": {
         "type": "object",
         "additionalProperties": false
       },
       "stress": {
         "type": "object",
         "additionalProperties": false
       },
       "strongAccent": {
         "type": "object",
         "properties": {
           "pointing": {
             "$ref": "#/$defs/up-or-down"
           }
         },
         "additionalProperties": false
       },
       "tenuto": {
         "type": "object",
         "additionalProperties": false
       },
       "tremolo": {
         "type": "object",
         "required": [
           "marks"
         ],
         "properties": {
           "marks": {
             "$ref": "#/$defs/positive-integer"
           }
         },
         "additionalProperties": false
       },
       "unstress": {
         "type": "object",
         "additionalProperties": false
       }
     },
     "additionalProperties": false
   },
   "measure": {
     "type": "boolean"
   },
   "notes": {
     "type": "array",
     "items": {
       "type": "object",
       "required": [
         "pitch"
       ],
       "properties": {
         "accidentalDisplay": {
           "type": "object",
           "required": [
             "show"
           ],
           "properties": {
             "enclosure": {
               "type": "object",
               "required": [
                 "symbol"
               ],
               "properties": {
                 "symbol": {
                   "type": "string",
                   "enum": [
                     "parentheses",
                     "brackets"
                   ]
                 }
               },
               "additionalProperties": false
             },
             "force": {
               "type": "boolean"
             },
             "show": {
               "type": "boolean"
             }
           },
           "additionalProperties": false
         },
         "class": {
           "$ref": "#/$defs/style-class"
         },
         "id": {
           "$ref": "#/$defs/id"
         },
         "perform": {
           "type": "object",
           "additionalProperties": false
         },
         "pitch": {
           "type": "object",
           "required": [
             "octave",
             "step"
           ],
           "properties": {
             "alter": {
               "type": "integer"
             },
             "octave": {
               "type": "integer"
             },
             "step": {
               "type": "string",
               "enum": [
                 "A",
                 "B",
                 "C",
                 "D",
                 "E",
                 "F",
                 "G"
               ]
             }
           },
           "additionalProperties": false
         },
         "smuflFont": {
           "$ref": "#/$defs/smufl-font"
         },
         "staff": {
           "$ref": "#/$defs/staff-number"
         },
         "ties": {
           "type": "array",
           "items": {
             "type": "object",
             "properties": {
               "lv": {
                 "type": "boolean"
               },
               "side": {
                 "$ref": "#/$defs/slur-side"
               },
               "target": {
                 "$ref": "#/$defs/id"
               }
             },
             "additionalProperties": false
           }
         }
       },
       "additionalProperties": false
     }
   },
   "orient": {
     "$ref": "#/$defs/orientation"
   },
   "rest": {
     "type": "object",
     "properties": {
       "staffPosition": {
         "$ref": "#/$defs/staff-position"
       }
     },
     "additionalProperties": false
   },
   "slurs": {
     "type": "array",
     "items": {
       "type": "object",
       "required": [
         "target"
       ],
       "properties": {
         "endNote": {
           "$ref": "#/$defs/id"
         },
         "lineType": {
           "type": "string",
           "enum": [
             "dashed",
             "dotted",
             "solid",
             "wavy"
           ]
         },
         "side": {
           "$ref": "#/$defs/slur-side"
         },
         "sideEnd": {
           "$ref": "#/$defs/slur-side"
         },
         "startNote": {
           "$ref": "#/$defs/id"
         },
         "target": {
           "$ref": "#/$defs/id"
         }
       },
       "additionalProperties": false
     }
   },
   "smuflFont": {
     "$ref": "#/$defs/smufl-font"
   },
   "staff": {
     "$ref": "#/$defs/staff-number"
   },
   "stemDirection": {
     "$ref": "#/$defs/stem-direction"
   },
   "type": {
     "type": "string",
     "const": "event"
   }
 },
 "additionalProperties": false
}

Fields§

§duration: Option<NoteValue>§id: Option<Id>§lyrics: Option<EventLyrics>§markings: Option<EventMarkings>§measure: Option<bool>§notes: Vec<EventNotesItem>§orient: Option<Orientation>§rest: Option<EventRest>§slurs: Vec<EventSlursItem>§smufl_font: Option<SmuflFont>§staff: Option<StaffNumber>§stem_direction: Option<StemDirection>§type_: Option<String>

Implementations§

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Event

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Event

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Event

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Event> for Event

Source§

fn from(value: &Event) -> Self

Converts to this type from the input type.
Source§

impl From<Event> for Event

Source§

fn from(value: Event) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Event

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Event> for Event

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Event) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,