Struct OctaveShift 

pub struct OctaveShift { /* private fields */ }

How far and which way an octave line moves the notes under it: music21’s Ottava.type.

Implementations

impl OctaveShift

pub fn from_name(name: &str, transposing: bool) -> Result<Self>

A shift by music21’s name for it: 8va, 8vb, 15ma, 15mb, 22da or 22db. transposing says whether the notes under it are written where they sound, as music21’s transposing says.

pub fn name(&self) -> &'static str

music21’s name for the shift, 8va.

pub fn magnitude(&self) -> u8

8, 15 or 22: music21’s shiftMagnitude.

pub fn up(&self) -> bool

Whether the notes sound higher than written: an 8va does.

pub fn transposing(&self) -> bool

Whether the notes under the line are written where they sound: music21’s transposing.

pub fn set_transposing(&mut self, transposing: bool)

Says whether the notes under the line are written where they sound. This moves no notes; crate::Stream::to_sounding_pitch and crate::Stream::to_written_pitch move them and say so.

pub fn interval(&self) -> Interval

How far the notes under the line sound from where they are written, one, two or three octaves up or down: music21’s interval().

Trait Implementations

impl Clone for OctaveShift

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OctaveShift

impl Debug for OctaveShift

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OctaveShift

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 Eq for OctaveShift

impl Hash for OctaveShift

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OctaveShift

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OctaveShift

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.

impl StructuralPartialEq for OctaveShift