Enum Components 

#[repr(usize)]
pub enum Components<T = usize> {
    Root(T),
    Third(T),
    Fifth(T),
}

A chord factor describes the position of a note within a triad. The root factor is the first note of the triad, the third factor is the second note of the triad, and the fifth factor is the third note of the triad.

Variants

Root(T)

Third(T)

Fifth(T)

Implementations

impl<T> Components<T>

pub const fn is_root(&self) -> bool

Returns true if the enum is Components::Root otherwise false

pub const fn is_third(&self) -> bool

Returns true if the enum is Components::Third otherwise false

pub const fn is_fifth(&self) -> bool

Returns true if the enum is Components::Fifth otherwise false

impl<T> Components<T>

pub fn new(data: T, factor: Factors) -> Self

pub fn factor(&self) -> Factors

Returns the factor of the chord.

pub fn fifth(data: T) -> Self

Initialize a new fifth factor.

pub fn root(data: T) -> Self

Initialize a new root factor.

pub fn third(data: T) -> Self

Initialize a new third factor.

Trait Implementations

impl<T> AsRef<str> for Components<T>

fn as_ref(&self) -> &str

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

impl<T: Clone> Clone for Components<T>

fn clone(&self) -> Components<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Components<T>

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

Formats the value using the given formatter.

impl<T> Display for Components<T>

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

Formats the value using the given formatter.

impl<T> EnumCount for Components<T>

const COUNT: usize = 3usize

impl<'_enum, T> From<&'_enum Components<T>> for Factors

fn from(val: &'_enum Components<T>) -> Factors

Converts to this type from the input type.

impl<T> From<Components<T>> for Factors

fn from(val: Components<T>) -> Factors

Converts to this type from the input type.

impl<T: Hash> Hash for Components<T>

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<T> IntoDiscriminant for Components<T>

type Discriminant = Factors

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant

impl<T: Ord> Ord for Components<T>

fn cmp(&self, other: &Components<T>) -> 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<T: PartialEq> PartialEq for Components<T>

fn eq(&self, other: &Components<T>) -> 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<T: PartialOrd> PartialOrd for Components<T>

fn partial_cmp(&self, other: &Components<T>) -> 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<T> VariantNames for Components<T>

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl<T: Copy> Copy for Components<T>

impl<T: Eq> Eq for Components<T>

impl<T> StructuralPartialEq for Components<T>