Skip to main content

PercussionInstrument

Struct PercussionInstrument 

Source
pub struct PercussionInstrument {
    pub id: String,
    pub name: Option<String>,
    pub midi_unpitched: Option<u8>,
    pub staff_position: Option<i8>,
    pub notehead: Option<NoteHead>,
    pub preferred_voice: Option<u8>,
    pub techniques: Vec<String>,
}

Fields§

§id: String

Stable MusicXML score-instrument identity.

§name: Option<String>§midi_unpitched: Option<u8>

General MIDI percussion key (0-based, 35 = acoustic bass drum, 38 = acoustic snare) played for this instrument. MusicXML <midi-unpitched> is 1-based and is converted on import and export.

§staff_position: Option<i8>

Diatonic staff position relative to the middle line.

§notehead: Option<NoteHead>

Default glyph when a note does not supply a renderer-specific override.

§preferred_voice: Option<u8>

Preferred one-based score voice for newly entered kit notes.

§techniques: Vec<String>

Named kit-specific variants such as rim-shot or open.

Implementations§

Source§

impl PercussionInstrument

An editable percussion-kit mapping associated with a MusicXML score-instrument identity.

The MIDI key remains the playback fallback, while the remaining fields describe renderer-independent notation defaults. Individual notes may still override these defaults.

Source

pub fn display_position(pitch: &Pitch) -> i8

Diatonic steps of a displayed unpitched note from the five-line staff’s middle line (B4 in the treble/percussion layout), the unit of staff_position.

Trait Implementations§

Source§

impl Clone for PercussionInstrument

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PercussionInstrument

Source§

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

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

impl<'de> Deserialize<'de> for PercussionInstrument

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 PartialEq for PercussionInstrument

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for PercussionInstrument

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 StructuralPartialEq for PercussionInstrument

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.