Struct etterna::Rate

pub struct Rate { /* fields omitted */ }

Represents an Etterna chart rate (music speed).

As in Etterna, this value can only be a multiple of 0.05. The value can’t be negative, nor NaN or infinity.

When printed, a Rate is formatted as usual in Etterna; two floating point digits and an x at the end: 0.85x, 1.00x, 2.40x

Implementations

impl Rate

pub fn from_f32(r: f32) -> Option<Self>

Rounds to the nearest valid rate.

Returns None if the given value is negative or too large

pub fn from_string(string: &str) -> Option<Self>

Parses a string into a rate. The string needs to be in the format \d+\.\d+[05]?

Returns None if parsing failed

pub fn from_x20(x20: u32) -> Self

Create a new rate from a value that is equal to the real rate multiplied by 20.

Due to the fact that Etterna ratings are always multiples of 0.05, every rate can be precicely represented precisely with a whole number when multiplied by 20.

pub fn as_f32(self) -> f32

Returns an f32 representation of this rate.

assert_eq!(Rate::from_string("1.40").unwrap().as_f32(), 1.4);

pub fn as_x20(self) -> u32

Returns this rate multiplied by 20. This will always result in a whole number, hence this function returns an integer.

assert_eq!(Rate::from_string("1.45").unwrap().as_x20(), 29);

Trait Implementations

impl Add<Rate> for Rate

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<Rate> for Rate

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Rate

fn clone(&self) -> Rate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rate

impl Debug for Rate

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

Formats the value using the given formatter.

impl Default for Rate

fn default() -> Self

Returns the “default value” for a type.

impl Display for Rate

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

Formats the value using the given formatter.

impl Eq for Rate

impl From<f32> for Rate

fn from(value: f32) -> Self

Performs the conversion.

impl FromStr for Rate

type Err = RateParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Rate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Rate

fn cmp(&self, other: &Rate) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Rate> for Rate

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

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

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

This method tests for !=.

impl PartialOrd<Rate> for Rate

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Rate

impl StructuralPartialEq for Rate

impl Sub<Rate> for Rate

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<Rate> for Rate

fn sub_assign(&mut self, other: Self)

Performs the -= operation.