Struct embedded_time::Fraction

pub struct Fraction(_);

A fractional value

Used primarily to define the scaling factor for the Duration, Rate, Instant and Clock traits and types.

Implementations

impl Fraction

pub const fn new(numerator: u32, denominator: u32) -> Self

Construct a new Fraction.

A reduction is not performed. Also there is no check for a denominator of 0. If these features are needed, use Fraction::new_reduce()

pub const fn numerator(&self) -> &u32

Return the numerator of the fraction

pub const fn denominator(&self) -> &u32

Return the denominator of the fraction

impl Fraction

pub fn new_reduce(
    numerator: u32,
    denominator: u32
) -> Result<Self, ConversionError>

Construct a new Fraction.

A reduction and denominator == 0 check are performed.

Errors

ConversionError::DivByZero : A 0 denominator was detected

pub fn to_integer(&self) -> u32

Returns the value truncated to an integer

pub fn from_integer(value: u32) -> Self

Constructs a Fraction from an integer.

Equivalent to Fraction::new(value,1).

pub fn recip(self) -> Self

Returns the reciprocal of the fraction

pub fn checked_mul(&self, v: &Self) -> Result<Self, ConversionError>

Checked Fraction × Fraction = Fraction

Examples

assert_eq!(Fraction::new(1000, 1).checked_mul(&Fraction::new(5,5)),
    Ok(Fraction::new(5_000, 5)));

assert_eq!(Fraction::new(u32::MAX, 1).checked_mul(&Fraction::new(2,1)),
    Err(ConversionError::Overflow));

Errors

ConversionError::Overflow

pub fn checked_div(&self, v: &Self) -> Result<Self, ConversionError>

Checked Fraction / Fraction = Fraction

Examples

assert_eq!(Fraction::new(1000, 1).checked_div(&Fraction::new(10, 1000)),
    Ok(Fraction::new(1_000_000, 10)));

assert_eq!(Fraction::new(1, u32::MAX).checked_div(&Fraction::new(2,1)),
    Err(ConversionError::Overflow));

Errors

ConversionError::Overflow

pub fn checked_mul_integer(
    &self,
    multiplier: u32
) -> Result<Self, ConversionError>

Checked Fraction × integer = Fraction

Examples

assert_eq!(Fraction::new(1000, 1).checked_mul_integer(5_u32),
    Ok(Fraction::new(5_000, 1)));

assert_eq!(Fraction::new(u32::MAX, 1).checked_mul_integer(2_u32),
    Err(ConversionError::Overflow));

Errors

ConversionError::Overflow ConversionError::DivByZero

pub fn checked_div_integer(&self, divisor: u32) -> Result<Self, ConversionError>

Checked Fraction / integer = Fraction

Examples

assert_eq!(Fraction::new(1000, 1).checked_div_integer(5_u32),
    Ok(Fraction::new(200, 1)));

assert_eq!(Fraction::new(1, 1000).checked_div_integer(5_u32),
    Ok(Fraction::new(1, 5000)));

assert_eq!(Fraction::new(1, u32::MAX).checked_div_integer(2_u32),
    Err(ConversionError::Overflow));

Errors

ConversionError::Overflow ConversionError::DivByZero

Trait Implementations

impl Clone for Fraction

fn clone(&self) -> Fraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Fraction

impl Debug for Fraction

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

Formats the value using the given formatter.

impl Div<Fraction> for Fraction

type Output = Self

The resulting type after applying the / operator.

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

Panicky Fraction / Fraction = Fraction

Examples

assert_eq!(Fraction::new(1000, 1) / Fraction::new(10, 1_000),
    Fraction::new(1_000_000, 10));

Panics

The same reason the integer operation would panic. Namely, if the result overflows the type.

impl Eq for Fraction

impl Mul<Fraction> for Fraction

type Output = Self

The resulting type after applying the * operator.

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

Panicky Fraction × Fraction = Fraction

Examples

assert_eq!(Fraction::new(1000, 1) * Fraction::new(5,5),
    Fraction::new(5_000, 5));

Panics

The same reason the integer operation would panic. Namely, if the result overflows the type.

impl Ord for Fraction

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Fraction> for Fraction

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

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

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

This method tests for !=.

impl PartialOrd<Fraction> for Fraction

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

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

fn lt(&self, other: &Fraction) -> bool

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

fn le(&self, other: &Fraction) -> bool

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

fn gt(&self, other: &Fraction) -> bool

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

fn ge(&self, other: &Fraction) -> bool

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

impl StructuralEq for Fraction

impl StructuralPartialEq for Fraction