Struct Tone

pub struct Tone {
    pub value: ToneValue,
    pub string_rep: String,
    pub lineno: Option<usize>,
}

A Tone is a single entry in a SCL file. It is expressed either in cents or in a ratio, as described in the SCL documentation.

In most normal use, you will not use this struct, and it will be internal to a Scale.

Fields

value: ToneValue

Value of the tone.

string_rep: String

String representation of the tone. Is set if parsed from string.

lineno: Option<usize>

Number of line on which the tone was specified. Is set if parsed from file.

Implementations

impl Tone

pub fn new() -> Self

Default constructor. Initializes tone with ratio 1/1 (or 0 cents).

pub fn cents(&self) -> f64

Returns cents value of a tone.

pub fn float_value(&self) -> f64

Returns float value of a tone. Equal to cents() / 1200 + 1.

pub fn from_string( line: &str, lineno: Option<usize>, ) -> Result<Self, TuningError>

Constructs a tone from a string.

Returns a TuningError::ParseError if line is not a valid tone representation.

Returns a TuningError::InvalidTone if line is a ratio with either denominator or numerator equal to 0.

Returns an Ok variant for valid tones.

Trait Implementations

impl Clone for Tone

fn clone(&self) -> Tone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tone

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

Formats the value using the given formatter.

impl Default for Tone

fn default() -> Self

Returns the “default value” for a type.

impl Display for Tone

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

Formats the value using the given formatter.

impl Ord for Tone

fn cmp(&self, other: &Tone) -> 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 Tone

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

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

const 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 Tone

fn partial_cmp(&self, other: &Tone) -> 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 Eq for Tone

impl StructuralPartialEq for Tone