Struct Ratio

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

A struct that represents a ratio and determines the legal value(s) for a given type. Clamps any values that fall beyond the valid legal range for the type. Used to convert a type into a valid percentage representation.

Implementations

impl Ratio

pub fn from_percentage(percentage: u8) -> Self

pub fn from_u8(value: u8) -> Self

pub fn from_f32(float: f32) -> Self

pub fn as_percentage(self) -> u8

pub fn as_u8(self) -> u8

pub fn as_f32(self) -> f32

Trait Implementations

impl Add for Ratio

type Output = Ratio

The resulting type after applying the + operator.

fn add(self, other: Ratio) -> Ratio

Performs the + operation.

impl Clone for Ratio

fn clone(&self) -> Ratio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ratio

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

Formats the value using the given formatter.

impl Display for Ratio

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

Formats the value using the given formatter.

impl Div for Ratio

type Output = Ratio

The resulting type after applying the / operator.

fn div(self, other: Ratio) -> Ratio

Performs the / operation.

impl Mul for Ratio

type Output = Ratio

The resulting type after applying the * operator.

fn mul(self, other: Ratio) -> Ratio

Performs the * operation.

impl Ord for Ratio

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

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

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

type Output = Ratio

The resulting type after applying the - operator.

fn sub(self, other: Ratio) -> Ratio

Performs the - operation.

impl Copy for Ratio

impl Eq for Ratio

impl StructuralPartialEq for Ratio