Skip to main content

PercussionChord

Struct PercussionChord 

Source
pub struct PercussionChord { /* private fields */ }
Expand description

Several strokes at once, as a hi-hat over a bass drum: music21’s percussion.PercussionChord.

It is not a harmony and answers none of a chord’s harmonic questions; its members stay in the order given.

use music21_rs::percussion::{PercussionChord, PercussionNote, Unpitched};
use music21_rs::Note;

let chord = PercussionChord::new(vec![
    Unpitched::from_display_name("E3")?.into(),
    Note::from_name("G4")?.into(),
])?;
assert_eq!(chord.len(), 2);
assert!(chord.is_unpitched(0) && !chord.is_unpitched(1));
assert_eq!(chord.pitches().len(), 1);

Implementations§

Source§

impl PercussionChord

Source

pub fn new(members: Vec<PercussionNote>) -> Result<Self>

A chord of these members, in this order.

Source

pub fn len(&self) -> usize

How many members it has.

Source

pub fn is_empty(&self) -> bool

Whether it has no members.

Source

pub fn is_unpitched(&self, index: usize) -> bool

Whether the member at this place has no pitch.

Source

pub fn members(&self) -> Vec<PercussionNote>

The members, in order.

Source

pub fn pitches(&self) -> Vec<Pitch>

The pitches of the members that have one: music21’s pitches.

Source

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

How long it lasts, where that has been said.

Source

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

The same chord lasting this long.

Source

pub fn written(&self) -> &Chord

Everything written about the chord as a whole – its length, stem, beams, expressions – and about each member, as a chord of notes standing where the members are displayed. It is a carrier of notation: its harmony means nothing.

Source

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

What is written about the chord, for editing. Adding or removing notes here is not supported: build a new chord instead.

Trait Implementations§

Source§

impl Clone for PercussionChord

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 PercussionChord

Source§

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

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

impl<'de> Deserialize<'de> for PercussionChord

Available on crate feature serde only.
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<PercussionChord> for StreamElement

Source§

fn from(value: PercussionChord) -> Self

Converts to this type from the input type.
Source§

impl Serialize for PercussionChord

Available on crate feature serde only.
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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.