Struct BrailleText 

pub struct BrailleText {
    pub line_length: usize,
    pub all_lines: Vec<BrailleTextLine>,
    pub right_hand_symbol: bool,
    pub left_hand_symbol: bool,
    pub all_headings: Vec<(usize, usize)>,
}

Braille laid out in lines, with headings, measure numbers and the signs of a hand at the keyboard: music21’s BrailleText.

Fields

line_length: usize

How many cells a line holds.

all_lines: Vec<BrailleTextLine>

Every line.

right_hand_symbol: bool

Whether lines of notes start with the right hand’s sign.

left_hand_symbol: bool

Whether lines of notes start with the left hand’s sign.

all_headings: Vec<(usize, usize)>

Where each heading’s lines start and end.

Implementations

impl BrailleText

pub fn new(line_length: usize, show_hand: Option<&str>) -> Result<Self>

Text of lines this long, with a hand’s sign where asked: right or left.

Errors

A hand music21 does not know.

pub fn set_show_hand(&mut self, hand: Option<&str>) -> Result<()>

Which hand’s sign the notes’ lines start with: music21’s showHand setter. music21’s getter never answers what was set.

Errors

A hand music21 does not know.

pub fn current_line(&mut self) -> &mut BrailleTextLine

The line being written.

pub fn make_new_line(&mut self)

Starts a new line: music21’s makeNewLine.

pub fn add_heading(&mut self, heading: &str) -> Result<()>

A heading, a line each, on lines of its own: music21’s addHeading.

Errors

A heading line wider than a line.

pub fn add_long_expression(&mut self, expression: &str) -> Result<()>

Words of a long text expression, each where it fits: music21’s addLongExpression.

Errors

A word wider than a line.

pub fn add_to_new_line(&mut self, grouping: &str) -> Result<()>

A group of notes on a new line, indented two cells or after the hand’s sign: music21’s addToNewLine.

Errors

A group wider than a line.

pub fn append_or_insert_current( &mut self, text: &str, add_space: bool, ) -> Result<()>

Text at the end of the line, or on a new one indented two cells: music21’s appendOrInsertCurrent.

Errors

Text wider than a line.

pub fn add_inaccord(&mut self, inaccord: &str) -> Result<()>

Voices written in accord, on the line or a new one: music21’s addInaccord.

Errors

Voices wider than a line.

pub fn add_measure_number(&mut self, number: &str) -> Result<()>

A measure number at the start of a line: music21’s addMeasureNumber.

Errors

A number wider than a line.

pub fn add_measure_number_value(&mut self, number: i64) -> Result<()>

A measure number given as a number.

Errors

A number wider than a line.

pub fn optional_add_keyboard_symbols_and_dots( &mut self, grouping: Option<&str>, ) -> Result<bool>

The hand’s sign and the dots of a group’s first cell, before the first group of a line, and whether what follows is spaced from it: music21’s optionalAddKeyboardSymbolsAndDots.

Errors

Signs wider than a line.

pub fn add_signatures(&mut self, signatures: &str) -> Result<()>

Key and time signatures, after a space unless they start the line: music21’s addSignatures.

Errors

Signatures wider than a line.

pub fn recenter_headings(&mut self)

Each heading line centred over the widest line of music below it, up to the next heading: music21’s recenterHeadings.

pub fn render(&mut self) -> String

The text, headings centred: music21’s __str__.

Trait Implementations

impl Clone for BrailleText

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 BrailleText

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

Formats the value using the given formatter.

impl Eq for BrailleText

impl PartialEq for BrailleText

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BrailleText