Skip to main content

BrailleSegment

Struct BrailleSegment 

Source
pub struct BrailleSegment {
    pub groupings: BTreeMap<SegmentKey, BrailleElementGrouping>,
    pub options: SegmentOptions,
    pub descending_chords: Option<bool>,
    pub end_hyphen: bool,
    pub begins_mid_measure: bool,
    pub contexts: Vec<NoteContext>,
}
Expand description

A part cut into segments of groupings, ready to transcribe: music21’s BrailleSegment.

Fields§

§groupings: BTreeMap<SegmentKey, BrailleElementGrouping>

The groupings, by key.

§options: SegmentOptions

The options it is written with.

§descending_chords: Option<bool>

Whether chords are written from the top down, as the clefs met so far say.

§end_hyphen: bool

Whether the segment ends in the middle of a measure.

§begins_mid_measure: bool

Whether it begins in the middle of a measure.

§contexts: Vec<NoteContext>

What music21 marked on each of the part’s leaves.

Implementations§

Source§

impl BrailleSegment

Source

pub fn add_grouping_attributes(&mut self)

Repeated measures counted, key signatures given their predecessors, full measures’ rests marked and each grouping told the signatures and options in force: music21’s addGroupingAttributes.

Source

pub fn fix_articulations(&mut self)

Runs of three or more notes with one articulation written with it doubled on the first and once on the last, and a staccato or tenuto over a tie written as a short slur: music21’s fixArticulations.

Source§

impl BrailleSegment

Source

pub fn transcribe(&mut self) -> Result<String>

The segment in braille: its heading and first measure number, then each grouping in turn: music21’s transcribe.

§Errors

Something too wide for a line, or that music21 cannot write.

Source

pub fn english(&self) -> String

The segment’s groupings in English, as music21’s __str__ lists them.

Trait Implementations§

Source§

impl Clone for BrailleSegment

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 BrailleSegment

Source§

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

Formats the value using the given formatter. 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> 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.