Struct Unpitched 

pub struct Unpitched { /* private fields */ }

A note with no pitch, as a drum stroke: music21’s note.Unpitched.

use music21_rs::percussion::Unpitched;

let stroke = Unpitched::new();
assert_eq!((stroke.display_step(), stroke.display_octave()), ('B', 4));

let low = Unpitched::from_display_name("D5")?;
assert_eq!(low.display_name(), "D5");

Implementations

impl Unpitched

pub fn new() -> Self

A stroke displayed on the middle line, B4, which is where music21 puts one that says nothing.

pub fn from_display_name(name: &str) -> Result<Self>

A stroke displayed where this pitch would stand in treble clef. An accidental in the name is dropped, since a display position has none, and a name with no octave is displayed in the fourth.

pub fn displayed_at(step: char, octave: IntegerType) -> Result<Self>

A stroke displayed at this step and octave.

pub fn display_step(&self) -> char

The letter of the line or space it is displayed on: music21’s displayStep.

pub fn display_octave(&self) -> IntegerType

The octave it is displayed in: music21’s displayOctave.

pub fn display_pitch(&self) -> &Pitch

Where it is displayed, as a pitch, which never has an accidental: music21’s displayPitch.

pub fn display_name(&self) -> String

Where it is displayed, as a name: music21’s displayName.

pub fn set_display(&mut self, step: char, octave: IntegerType) -> Result<()>

Moves it to another line or space.

pub fn duration(&self) -> Option<&Duration>

How long it lasts, where that has been said.

pub fn with_duration(self, duration: Duration) -> Self

The same stroke lasting this long.

pub fn stored_instrument(&self) -> Option<&Instrument>

The instrument that plays it, where one is kept on the stroke itself: music21’s storedInstrument.

pub fn written(&self) -> &Note

Everything written about the stroke – its length, stem, notehead, beams, tie, lyrics, expressions – as a note standing where it is displayed. The note’s pitch is that position and nothing sounds it.

pub fn written_mut(&mut self) -> &mut Note

What is written about the stroke, for editing. Changing the pitch moves where it is displayed.

Trait Implementations

impl Clone for Unpitched

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 Unpitched

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

Formats the value using the given formatter.

impl Default for Unpitched

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Unpitched

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Unpitched> for PercussionNote

fn from(value: Unpitched) -> Self

Converts to this type from the input type.

impl From<Unpitched> for StreamElement

fn from(value: Unpitched) -> Self

Converts to this type from the input type.

impl PartialEq for Unpitched

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

Where they are displayed, what plays them and how long they last, as music21 compares them.

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

Inequality operator !=.

impl Serialize for Unpitched

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.