Struct musictheory::types::Steps

pub struct Steps(_);

Steps is the distance in semitones between two PitchClasses.

Methods

impl Steps

pub fn distance(l: &PitchClass, r: &PitchClass) -> Steps

Get the distance between two PitchClasses.

pub fn cents(&self) -> Cents

Cents represented by this Steps.

pub fn value(&self) -> u16

Number of Steps.

Trait Implementations

impl Add<Steps> for Pitch

type Output = Option<Self>

The resulting type after applying the + operator.

fn add(self, steps: Steps) -> Self::Output

Performs the + operation.

impl Add<Steps> for PitchClass

type Output = Self

The resulting type after applying the + operator.

fn add(self, steps: Steps) -> Self::Output

Performs the + operation.

impl Clone for Steps

fn clone(&self) -> Steps

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Steps

impl Debug for Steps

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

Formats the value using the given formatter.

impl Display for Steps

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

Formats the value using the given formatter.

impl From<Cents> for Steps

fn from(value: Cents) -> Steps

Performs the conversion.

impl From<Steps> for Cents

fn from(value: Steps) -> Cents

Performs the conversion.

impl From<u16> for Steps

fn from(value: u16) -> Steps

Performs the conversion.

impl PartialEq<Steps> for Steps

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

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

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

This method tests for !=.

impl PartialOrd<Steps> for Steps

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Steps

impl Sub<Steps> for Pitch

type Output = Option<Self>

The resulting type after applying the - operator.

fn sub(self, steps: Steps) -> Self::Output

Performs the - operation.

impl Sub<Steps> for PitchClass

type Output = Self

The resulting type after applying the - operator.

fn sub(self, steps: Steps) -> Self::Output

Performs the - operation.