Struct ukebox::chord_chart::ChordChart

source · [−]

pub struct ChordChart { /* private fields */ }

Implementations

source

impl ChordChart

source

pub fn new(voicing: Voicing, width: Semitones) -> Self

source

pub fn get_base_fret(&self) -> FretID

Determine from which fret to show the fretboard.

If the rightmost fret fits on the diagram, show the fretboard beginning at the first fret, otherwise use the leftmost fret needed for the chords to be played.

source

pub fn get_root_width(&self) -> usize

Get the width of the space that we need to print the names of the root notes (the names of the strings).

source

pub fn format_line(
    &self,
    uke_string: UkeString,
    base_fret: FretID,
    root_width: usize,
    finger: u8
) -> String

Format a line that represents a ukulele string in a chord diagram.

Trait Implementations

source

impl Display for ChordChart

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for ChordChart

impl Send for ChordChart

impl Sync for ChordChart

impl Unpin for ChordChart

impl UnwindSafe for ChordChart

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ukebox::chord_chart::ChordChart

Implementations

impl ChordChart

pub fn new(voicing: Voicing, width: Semitones) -> Self

pub fn get_base_fret(&self) -> FretID

pub fn get_root_width(&self) -> usize

pub fn format_line(
    &self,
    uke_string: UkeString,
    base_fret: FretID,
    root_width: usize,
    finger: u8
) -> String

Trait Implementations

impl Display for ChordChart

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

Auto Trait Implementations

impl RefUnwindSafe for ChordChart

impl Send for ChordChart

impl Sync for ChordChart

impl Unpin for ChordChart

impl UnwindSafe for ChordChart

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct ukebox::chord_chart::ChordChart

Implementations

impl ChordChart

pub fn new(voicing: Voicing, width: Semitones) -> Self

pub fn get_base_fret(&self) -> FretID

pub fn get_root_width(&self) -> usize

pub fn format_line( &self, uke_string: UkeString, base_fret: FretID, root_width: usize, finger: u8) -> String

Trait Implementations

impl Display for ChordChart

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

Auto Trait Implementations

impl RefUnwindSafe for ChordChart

impl Send for ChordChart

impl Sync for ChordChart

impl Unpin for ChordChart

impl UnwindSafe for ChordChart

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn format_line(
&self,
uke_string: UkeString,
base_fret: FretID,
root_width: usize,
finger: u8
) -> String

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,