Struct Decibels 

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

A level in decibels: any finite value. A negative value is common, because levels are often relative to a peak.

use sound_to_patch::units::Decibels;

let level = Decibels::new(-6.0)?;
assert!(Decibels::new(f64::NAN).is_err());

Implementations

impl Decibels

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

Returns the amplitude gain 10^(dB / 20), the factor for a magnitude such as a sample value or a spectral magnitude weight.

use sound_to_patch::units::Decibels;

let gain = Decibels::new(-20.0)?.to_amplitude_gain()?;
assert!((gain - 0.1).abs() < 1e-15);

Errors

Returns a RangeError beyond ±6000 dB, a conservative cap that keeps the gain finite and nonzero.

pub fn from_amplitude_gain(gain: f64) -> Result<Decibels, RangeError>

Converts an amplitude gain: dB = 20 * log10(gain). The result can lie beyond the cap of Decibels::to_amplitude_gain.

Errors

Returns a RangeError for a gain of zero or less, which has no decibel value, or one that is not finite.

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

Returns the power ratio 10^(dB / 10), the factor for an energy or a power, such as the share of a frequency band.

Errors

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

pub fn from_power_ratio(ratio: f64) -> Result<Decibels, RangeError>

Converts a power ratio: dB = 10 * log10(ratio). The result can lie beyond the cap of Decibels::to_power_ratio.

Errors

Returns a RangeError for a ratio of zero or less, or one that is not finite.

impl Decibels

pub fn new(value: f64) -> Result<Decibels, 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 Decibels

fn clone(&self) -> Decibels

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Decibels

impl Debug for Decibels

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Decibels

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Decibels

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 Decibels

type Err = ParseUnitError

The associated error which can be returned from parsing.

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

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

impl PartialEq for Decibels

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Decibels

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

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 Decibels

impl StructuralPartialEq for Decibels

impl TryFrom<f64> for Decibels

type Error = RangeError

The type returned in the event of a conversion error.

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

Performs the conversion.