Struct BrailleGrandSegment 

pub struct BrailleGrandSegment {
    pub groupings: BTreeMap<SegmentKey, BrailleElementGrouping>,
    pub line_length: usize,
    pub right_contexts: Vec<NoteContext>,
    pub left_contexts: Vec<NoteContext>,
}

A piano’s two staves cut into segments of groupings for each hand, written side by side: music21’s BrailleGrandSegment.

Fields

groupings: BTreeMap<SegmentKey, BrailleElementGrouping>

The groupings of both hands, by key.

line_length: usize

How many cells a line holds.

right_contexts: Vec<NoteContext>

What music21 marked on each leaf of the right hand’s part.

left_contexts: Vec<NoteContext>

What music21 marked on each leaf of the left hand’s part.

Implementations

impl BrailleGrandSegment

pub fn combined_keys(&self) -> Vec<KeyPair>

The keys of the two hands, paired measure by measure: music21’s yieldCombinedGroupingKeys.

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

The two hands in braille: a heading, then each measure’s groupings side by side: music21’s transcribe.

Errors

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

pub fn transcribe_into(&mut self, keyboard: &mut BrailleKeyboard) -> Result<()>

BrailleGrandSegment::transcribe into a keyboard’s text as it stands, rather than a fresh one.

Errors

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

pub fn extract_heading( &mut self, pairs: &mut VecDeque<KeyPair>, keyboard: &mut BrailleKeyboard, ) -> Result<()>

The heading out of the pairs the segment starts with, which it takes off them: music21’s extractHeading. Nothing is written where there is nothing for a heading.

Errors

A heading too wide for a line.

pub fn extract_note_grouping( &mut self, (right, left): KeyPair, keyboard: &mut BrailleKeyboard, ) -> Result<()>

A measure’s pair of groupings written side by side: music21’s extractNoteGrouping.

Errors

A pair with neither hand, or a grouping too wide for a line.

pub fn english(&self) -> String

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

Trait Implementations

impl Clone for BrailleGrandSegment

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 BrailleGrandSegment

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

Formats the value using the given formatter.