Temperature

Enum Temperature 

Source
pub enum Temperature {
    Fahrenheit(f64),
    Celsius(f64),
    Kelvin(f64),
}
Expand description

A value that’s one of many common temperature units.

Wraps a floating point number to give it a unit! You can create a new Temperature by putting a float value inside.

Important: Temperature is not checked, so invalid states are completely allowed.

 use simmer::Temperature;

 let my_temp = Temperature::Celsius(0.0);

Variants§

§

Fahrenheit(f64)

§

Celsius(f64)

§

Kelvin(f64)

Implementations§

Source§

impl Temperature

Source

pub fn to_fahrenheit(&self) -> Temperature

Return a Temperature in Fahrenheit based off of Self.

§Usage
let body_temp_c = Temperature::Celsius(37.0);

let body_temp_f = body_temp_c.to_fahrenheit();
assert_approx_eq!(body_temp_f.into_inner(), 98.6);
Source

pub fn to_celsius(&self) -> Temperature

Return a Temperature in Celsius based off of Self.

§Usage
let body_temp_f = Temperature::Fahrenheit(98.6);

let body_temp_c = body_temp_f.to_celsius();
assert_approx_eq!(body_temp_c.into_inner(), 37.0);
Source

pub fn to_kelvin(&self) -> Temperature

Return a Temperature in Kelvin based off of Self.

§Usage
let abs_zero_k = Temperature::Kelvin(0.0);

let abs_zero_c = abs_zero_k.to_celsius();
assert_approx_eq!(abs_zero_c.into_inner(), -273.15);
Source

pub fn into_inner(self) -> f64

A discovery function that returns the inner type, consuming the outer Temperature type. Use my_temp.into() when possible.

§Usage
let my_temp = Temperature::Fahrenheit(98.6);
let my_temp_float = my_temp.into_inner();
Source

pub const fn get_inner(&self) -> f64

Gets the inner floating point value.

§Usage
let temp = Temperature::Kelvin(0.0);
let temp_inner = temp.get_inner();

println!("{temp:?}'s inner is {temp_inner}");
Source

pub fn is_below_abs_zero(&self) -> bool

Tells you if a Temperature is below absolute zero - an invalid state for temperature.

So… returns:

  • true if t >= abs zero
  • false if t < abs zero
§Usage
let temp = Temperature::Kelvin(0.0);
assert!(!temp.is_below_abs_zero());

let temp2 = Temperature::Kelvin(-0.1);
assert!(temp2.is_below_abs_zero());
Source

pub fn is_nan(&self) -> bool

Checks if the internal floating point number is NaN.

§Usage
let temp = Temperature::Fahrenheit(f64::NAN);
assert!(temp.is_nan());

Trait Implementations§

Source§

impl Add for Temperature

Source§

type Output = Temperature

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Temperature) -> <Temperature as Add>::Output

Performs the + operation. Read more
Source§

impl Clone for Temperature

Source§

fn clone(&self) -> Temperature

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Temperature

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Temperature

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div<f64> for Temperature

Source§

type Output = Temperature

The resulting type after applying the / operator.
Source§

fn div(self, rhs: f64) -> <Temperature as Div<f64>>::Output

Performs the / operation. Read more
Source§

impl Into<f64> for Temperature

Source§

fn into(self) -> f64

Converts this type into the (usually inferred) input type.
Source§

impl Mul<f64> for Temperature

Source§

type Output = Temperature

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: f64) -> <Temperature as Mul<f64>>::Output

Performs the * operation. Read more
Source§

impl PartialEq for Temperature

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Temperature

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Sub for Temperature

Source§

type Output = Temperature

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Temperature) -> <Temperature as Sub>::Output

Performs the - operation. Read more
Source§

impl uDebug for Temperature

Source§

fn fmt<W>(&self, f: &mut Formatter<'_, W>) -> Result<(), <W as uWrite>::Error>
where W: uWrite + ?Sized,

Formats the value using the given formatter
Source§

impl uDisplay for Temperature

Source§

fn fmt<W>(&self, f: &mut Formatter<'_, W>) -> Result<(), <W as uWrite>::Error>
where W: uWrite + ?Sized,

Formats the value using the given formatter
Source§

impl Copy for Temperature

Source§

impl StructuralPartialEq for Temperature

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.