Struct Articulation 

pub struct Articulation { /* private fields */ }

An articulation: how a note is played, and the numbers that say it.

Two articulations are equal when they are of one kind, as music21’s are; where they sit and what else they say does not count.

use music21_rs::articulations::{Articulation, ArticulationKind};

let accent = Articulation::of_kind(ArticulationKind::StrongAccent);
assert_eq!(accent.name(), "strong accent");
assert!(accent.volume_shift() > 0.1);
assert!(accent.is_a("Accent"));

Implementations

impl Articulation

pub fn of_kind(kind: ArticulationKind) -> Self

An articulation as music21’s class for kind starts out.

pub fn kind(&self) -> ArticulationKind

The kind of articulation this started as.

pub fn is_a(&self, class: &str) -> bool

Whether this is an articulation of that music21 class or one below it: is_a("Staccato") holds for a spiccato.

pub fn name(&self) -> String

music21’s name: the class name as lower-case words, so a snap pizzicato is "snap pizzicato".

pub fn placement(&self) -> Option<&str>

Where the mark sits: "above", "below", or nothing said.

pub fn set_placement(&mut self, placement: Option<String>)

Says where the mark sits.

pub fn volume_shift(&self) -> FloatType

How much the mark shifts the note’s volume, between -1 and 1: music21’s volumeShift, which crate::Volume::realized_with adds.

pub fn set_volume_shift(&mut self, shift: FloatType)

Changes the volume shift, held between -1 and 1.

pub fn length_shift(&self) -> FloatType

What the note’s sounding length is multiplied by: music21’s lengthShift, 0.7 for a staccato.

pub fn set_length_shift(&mut self, shift: FloatType)

Changes the length shift.

pub fn tie_attach(&self) -> &str

Which part of a note split across a tie keeps the mark: music21’s tieAttach, "first", "last" or "all".

pub fn set_tie_attach(&mut self, attach: impl Into<String>)

Changes which part keeps the mark.

pub fn display_text(&self) -> Option<&str>

Text written for the mark instead of its usual sign.

pub fn set_display_text(&mut self, text: Option<String>)

Changes the text written for the mark.

pub fn finger(&self) -> Option<&Finger>

A fingering’s finger: music21’s fingerNumber.

pub fn set_finger(&mut self, finger: Option<Finger>)

Changes the finger.

pub fn substitution(&self) -> bool

Whether a fingering or organ mark is a substitution.

pub fn set_substitution(&mut self, substitution: bool)

Says whether it is a substitution.

pub fn alternate(&self) -> bool

Whether a fingering is an alternate one.

pub fn set_alternate(&mut self, alternate: bool)

Says whether it is an alternate.

pub fn number(&self) -> IntegerType

A string or fret indication’s number: music21’s number, nought when none is given.

pub fn set_number(&mut self, number: IntegerType)

Changes the string or fret number.

pub fn point_direction(&self) -> Option<&str>

Which way a strong accent points: music21’s pointDirection.

pub fn set_point_direction(&mut self, direction: Option<String>)

Changes which way it points.

pub fn symbol(&self) -> Option<&str>

A breath mark’s symbol.

pub fn set_symbol(&mut self, symbol: Option<String>)

Changes the breath mark’s symbol.

pub fn harmonic_type(&self) -> Option<&str>

A string harmonic’s type: "natural" unless said otherwise.

pub fn set_harmonic_type(&mut self, harmonic_type: Option<String>)

Changes the harmonic’s type.

pub fn pitch_type(&self) -> Option<&str>

Which pitch a string harmonic’s written note stands for.

pub fn set_pitch_type(&mut self, pitch_type: Option<String>)

Changes which pitch the written note stands for.

pub fn bend_alter(&self) -> Option<&ChromaticInterval>

How far a fret bend bends the string: music21’s bendAlter.

pub fn set_bend_alter(&mut self, alter: Option<ChromaticInterval>)

Changes how far the string is bent.

pub fn pre_bend(&self) -> bool

Whether the string is bent before the note sounds.

pub fn set_pre_bend(&mut self, pre_bend: bool)

Says whether the string is bent beforehand.

pub fn release(&self) -> Option<FloatType>

When the bend is released, in quarter lengths from the start of the note.

pub fn set_release(&mut self, release: Option<FloatType>)

Changes when the bend is released.

pub fn with_bar(&self) -> Option<&str>

The whammy-bar movement a bend uses: "scoop" or "dip".

pub fn set_with_bar(&mut self, with_bar: Option<String>)

Changes the whammy-bar movement.

Trait Implementations

impl Clone for Articulation

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 Articulation

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

Formats the value using the given formatter.

impl Default for Articulation

fn default() -> Self

music21’s bare Articulation.

impl<'de> Deserialize<'de> for Articulation

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Articulation

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.