Struct Octaves 

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

An interval in octaves: any finite value, sign allowed.

use sound_to_patch::units::Octaves;

let spread = Octaves::new(0.3)?;
assert!(Octaves::new(f64::NEG_INFINITY).is_err());

Implementations

impl Octaves

pub fn to_ratio(self) -> Result<f64, RangeError>

Returns the frequency ratio 2^o.

Errors

Returns a RangeError beyond ±1000 octaves, a conservative cap that keeps the ratio finite and nonzero.

impl Octaves

pub fn new(value: f64) -> Result<Octaves, RangeError>

Checks the value against the range of the type.

Errors

Returns a RangeError for NaN, an infinity or a value outside the range.

pub fn get(self) -> f64

Returns the inner value.

Trait Implementations

impl Clone for Octaves

fn clone(&self) -> Octaves

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Octaves

impl Debug for Octaves

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Octaves

fn deserialize<__D>( __deserializer: __D, ) -> Result<Octaves, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Octaves

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

Prints the shortest number that parses back to the same value, then the first suffix.

impl FromStr for Octaves

type Err = ParseUnitError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Octaves, ParseUnitError>

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

impl PartialEq for Octaves

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Octaves

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spread for Octaves

impl StructuralPartialEq for Octaves

impl TryFrom<f64> for Octaves

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Octaves, RangeError>

Performs the conversion.