Struct Percent 

pub struct Percent<P>
where
    P: Polarity,
{ /* private fields */ }

A percentage. The polarity fixes the range: Percent<Unipolar> takes 0 to 100, Percent<Bipolar> takes -100 to 100.

A unipolar value widens to a bipolar one with From; the reverse is a TryFrom.

use sound_to_patch::units::{Bipolar, Percent, Unipolar};

let drive = Percent::<Unipolar>::new(25.0)?;
let amount = Percent::<Bipolar>::new(-100.0)?;
assert!(Percent::<Unipolar>::new(-1.0).is_err());
assert!(Percent::<Bipolar>::new(-101.0).is_err());

Implementations

impl<P> Percent<P>

where P: Polarity,

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

Checks the value against the range of the polarity.

Errors

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

pub fn get(self) -> f64

Returns the inner value, in percent.

Trait Implementations

impl<P> Clone for Percent<P>

where P: Polarity,

fn clone(&self) -> Percent<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Copy for Percent<P>

where P: Polarity,

impl<P> Debug for Percent<P>

where P: Polarity,

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for Percent<P>

where P: Polarity,

fn deserialize<D>( deserializer: D, ) -> Result<Percent<P>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P> Display for Percent<P>

where P: Polarity,

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

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

impl From<Percent<Unipolar>> for Percent<Bipolar>

fn from(value: Percent<Unipolar>) -> Percent<Bipolar>

Converts to this type from the input type.

impl<P> FromStr for Percent<P>

where P: Polarity,

type Err = ParseUnitError

The associated error which can be returned from parsing.

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

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

impl<P> PartialEq for Percent<P>

where P: Polarity,

fn eq(&self, other: &Percent<P>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<P> PartialOrd for Percent<P>

where P: Polarity,

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

where P: Polarity,

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<P: Polarity> Spread for Percent<P>

impl TryFrom<Percent<Bipolar>> for Percent<Unipolar>

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(value: Percent<Bipolar>) -> Result<Percent<Unipolar>, RangeError>

Performs the conversion.

impl<P> TryFrom<f64> for Percent<P>

where P: Polarity,

type Error = RangeError

The type returned in the event of a conversion error.

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

Performs the conversion.