Struct InstrumentDefinition 

pub struct InstrumentDefinition {

    pub id: String,
    pub name: String,
    pub short_name: String,
    pub family: Option<String>,
    pub transpose_semitones: i8,
    pub written_range: Option<InstrumentRange>,
    pub sounding_range: Option<InstrumentRange>,
    pub default_clefs: Vec<Clef>,
    pub staff_count: u8,
    pub staff_kind: StaffKind,
    pub midi_channel: u8,
    pub midi_program: u8,
    pub percussion_map_id: Option<String>,
}

Stable, renderer-independent instrument semantics for a part.

This is deliberately separate from a part’s current MIDI state: the latter records imported/performance values, while this definition supplies the instrument identity, notation defaults, and practical written/sounding ranges used by editors and layout clients.

Fields

id: String

Stable source or application-defined identifier. It must be non-empty.

name: String

short_name: String

family: Option<String>

transpose_semitones: i8

written_range: Option<InstrumentRange>

sounding_range: Option<InstrumentRange>

default_clefs: Vec<Clef>

staff_count: u8

staff_kind: StaffKind

midi_channel: u8

midi_program: u8

percussion_map_id: Option<String>

Implementations

impl InstrumentDefinition

pub fn new(id: impl Into<String>, name: impl Into<String>) -> Self

Construct a minimal single-staff instrument declaration.

Trait Implementations

impl Clone for InstrumentDefinition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstrumentDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InstrumentDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InstrumentDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InstrumentDefinition