Struct FSharpNote 

#[repr(transparent)]
pub struct FSharpNote<const N: isize = 6>;

Implementations

impl<const N: isize> FSharpNote<N>

pub const C_MAJOR_ID: usize = 6usize

pub const fn new() -> Self

pub fn is(value: isize) -> bool

returns true if the pitch class corresponds to the given value

pub const fn get(&self) -> &isize

returns a reference to the assigned index

pub const fn value(self) -> isize

returns the assigned index value

pub const fn name(&self) -> &str

returns the name of the pitch class

pub const fn symbol(&self) -> char

returns the symbol associated with the pitch class

impl FSharpNote<6>

pub const fn default() -> Self

a constructor for the pitch class that uses the default index for the target

Methods from Deref<Target = isize>

pub const MIN: isize = -9_223_372_036_854_775_808isize

pub const MAX: isize = 9_223_372_036_854_775_807isize

pub const BITS: u32 = 64u32

Trait Implementations

impl<const N: isize> AsRef<isize> for FSharpNote<N>

fn as_ref(&self) -> &isize

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: isize> AsRef<str> for FSharpNote<N>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: isize> Borrow<isize> for FSharpNote<N>

fn borrow(&self) -> &isize

Immutably borrows from an owned value.

impl<const N: isize> Clone for FSharpNote<N>

fn clone(&self) -> FSharpNote<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: isize> Debug for FSharpNote<N>

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

Formats the value using the given formatter.

impl<const N: isize> Default for FSharpNote<N>

fn default() -> FSharpNote<N>

Returns the “default value” for a type.

impl<const N: isize> Deref for FSharpNote<N>

type Target = isize

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const N: isize> Display for FSharpNote<N>

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

Formats the value using the given formatter.

impl<const N: isize> FromStr for FSharpNote<N>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const N: isize> Hash for FSharpNote<N>

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<const N: isize> Ord for FSharpNote<N>

fn cmp(&self, other: &FSharpNote<N>) -> 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<const N: isize> PartialEq<FSharpNote<N>> for isize

fn eq(&self, other: &FSharpNote<N>) -> 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<const N: isize> PartialEq<isize> for FSharpNote<N>

fn eq(&self, other: &isize) -> 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<const N: isize> PartialEq<str> for FSharpNote<N>

fn eq(&self, other: &str) -> 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<const N: isize> PartialEq for FSharpNote<N>

fn eq(&self, other: &FSharpNote<N>) -> 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<const N: isize> PartialOrd<FSharpNote<N>> for isize

fn partial_cmp(&self, other: &FSharpNote<N>) -> 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<const N: isize> PartialOrd<isize> for FSharpNote<N>

fn partial_cmp(&self, other: &isize) -> 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<const N: isize> PartialOrd for FSharpNote<N>

fn partial_cmp(&self, other: &FSharpNote<N>) -> 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<const N: isize> PitchClassRepr for FSharpNote<N>

const IDX: isize = N

fn is(value: isize) -> bool

where Self: Sized,

returns true if the given value corresponds to this pitch class

impl<const N: isize> RawPitchClass for FSharpNote<N>

type Tag = Sharp

fn new() -> Self

fn name(&self) -> &str

returns the name of the pitch class; i.e., “C”, “D”, “E”, etc.

fn index(&self) -> isize

returns the value associated with the pitch class

impl<const N: isize> TryFrom<isize> for FSharpNote<N>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: isize> Copy for FSharpNote<N>

impl<const N: isize> Eq for FSharpNote<N>

impl<const N: isize> StructuralPartialEq for FSharpNote<N>