Enum tune::scala::KbmBuildError

pub enum KbmBuildError {
    FormalOctaveMissing,
    MappingTooLarge,
}

Error reported when building a Kbm fails.

Variants

FormalOctaveMissing

No formal octave parameter has been set.

The formal octave parameter is mandatory if at least one key is pushed.

Examples

// No key pushed. The mapping is linear and the formal octave parameter is optional.
let optional = Kbm::builder(Note::from_midi_number(0));
assert!(optional.build().is_ok());

// At least one key pushed. The formal octave parameter is mandatory.
let mandatory = Kbm::builder(Note::from_midi_number(0)).push_mapped_key(0);
assert_eq!(mandatory.build().unwrap_err(), KbmBuildError::FormalOctaveMissing);

MappingTooLarge

There are too many items in this mapping.

// The number of items is below the threshold.
let mut below = Kbm::builder(Note::from_midi_number(62)).formal_octave(0);
for _ in 0..65535 {
    below = below.push_mapped_key(0);
}
assert!(below.build().is_ok());

// The number of items is above the threshold.
let mut above = Kbm::builder(Note::from_midi_number(62)).formal_octave(0);
for _ in 0..65536 {
    above = above.push_mapped_key(0);
}
assert_eq!(above.build().unwrap_err(), KbmBuildError::MappingTooLarge);

Trait Implementations

impl Clone for KbmBuildError

fn clone(&self) -> KbmBuildError

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KbmBuildError

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

Formats the value using the given formatter.

impl Eq for KbmBuildError

impl From<KbmBuildError> for KbmImportError

fn from(v: KbmBuildError) -> Self

Performs the conversion.

impl PartialEq<KbmBuildError> for KbmBuildError

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for KbmBuildError

impl StructuralPartialEq for KbmBuildError