Struct PercentageValue

pub struct PercentageValue { /* private fields */ }

Wrapper around FloatValue, represents a percentage instead of just being a regular floating-point value, i.e 5 = 5%

Implementations

impl PercentageValue

pub const fn const_new(value: isize) -> Self

Same as PercentageValue::new(), but only accepts whole numbers, since using f32 in const fn is not yet stabilized.

pub fn new(value: f32) -> Self

pub fn get(&self) -> f32

Trait Implementations

impl Clone for PercentageValue

fn clone(&self) -> PercentageValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PercentageValue

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

Formats the value using the given formatter.

impl Default for PercentageValue

fn default() -> PercentageValue

Returns the “default value” for a type.

impl Display for PercentageValue

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

Formats the value using the given formatter.

impl Hash for PercentageValue

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PercentageValue

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

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

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

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 PercentageValue

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

impl Eq for PercentageValue

impl StructuralPartialEq for PercentageValue