Struct StringNumber 

pub struct StringNumber(/* private fields */);

A validated guitar string number in the range 1..=12.

String numbers follow guitar convention: string 1 is the highest-pitched (thinnest) string, and higher numbers designate lower-pitched strings.

Implementations

impl StringNumber

pub const MAX: u8 = 12

Upper bound enforced by StringNumber::new.

pub fn new(string_number: u8) -> Result<Self, TabError>

Constructs a StringNumber after validating that string_number is in 1..=MAX.

Errors

Returns TabError::StringNumberOutOfRange if string_number is 0 or exceeds StringNumber::MAX.

pub fn get(self) -> u8

Returns the underlying u8.

Trait Implementations

impl Clone for StringNumber

fn clone(&self) -> StringNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StringNumber

impl Debug for StringNumber

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

Formats the value using the given formatter.

impl Eq for StringNumber

impl Hash for StringNumber

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StringNumber

fn cmp(&self, other: &StringNumber) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StringNumber

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StringNumber

fn partial_cmp(&self, other: &StringNumber) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for StringNumber