Struct FretBoard 

pub struct FretBoard {
    pub strings: usize,
    pub fret_notes: Vec<FretNote>,
    pub display_frets: usize,
    pub tuning: Vec<Pitch>,
}

A fretted instrument’s strings, the notes stopped on them, and their open pitches: music21’s FretBoard.

Fields

strings: usize

How many strings there are.

fret_notes: Vec<FretNote>

The notes stopped, in no particular order.

display_frets: usize

How many frets a diagram shows.

tuning: Vec<Pitch>

Each string’s open pitch, lowest string first.

Implementations

impl FretBoard

pub fn new( strings: usize, fret_notes: Vec<FretNote>, display_frets: usize, ) -> Self

A board of so many strings with these notes, not yet tuned.

pub fn guitar(fret_notes: Vec<FretNote>, display_frets: usize) -> Self

A guitar’s six strings, E2 A2 D3 G3 B3 E4: music21’s GuitarFretBoard.

pub fn ukulele(fret_notes: Vec<FretNote>, display_frets: usize) -> Self

A ukulele’s four strings, re-entrant G4 C4 E4 A4: music21’s UkeleleFretBoard.

pub fn bass_guitar(fret_notes: Vec<FretNote>, display_frets: usize) -> Self

A bass guitar’s four strings, E1 A1 D2 G2: music21’s BassGuitarFretBoard.

pub fn mandolin(fret_notes: Vec<FretNote>, display_frets: usize) -> Self

A mandolin’s four courses, G3 D4 A4 E5: music21’s MandolinFretBoard.

pub fn fret_note_by_string(&self, string: IntegerType) -> Option<&FretNote>

The note on a string, the first if several are: music21’s getFretNoteByString.

pub fn fret_notes_lowest_first(&self) -> Vec<&FretNote>

The note on each string that has one, lowest-sounding string first: music21’s fretNotesLowestFirst.

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

The pitch each string sounds, lowest string first, nothing for a string with no note: music21’s getPitches. A note’s pitch is its string’s open pitch raised by its fret, spelled as music21 spells a pitch made from a number. Strings are found as music21 finds them, counting back from the highest, so a note naming no string is read as on the lowest.

Errors

A board whose tuning is not one pitch a string, or a note on a string the board has not got.

Trait Implementations

impl Clone for FretBoard

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 FretBoard

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FretBoard

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 PartialEq for FretBoard

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FretBoard

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 FretBoard