pub struct Progress(_);
Expand description

a f64 type which is constrained to the range of 0.0 and 1.0

Implementations§

source§

impl Progress

source

pub fn from_percent(percent: impl Into<f64>) -> Progress

Create a Progress from a percentage

use lazy_async_promise::Progress;
let progress_half = Progress::from_percent(50);
source

pub fn from_fraction( numerator: impl Into<f64>, denominator: impl Into<f64> ) -> Progress

Create a Progress from a fraction, useful for handling loops

use lazy_async_promise::Progress;
let num_iterations = 100;
for i in 0..num_iterations {
  let progress_current = Progress::from_fraction(i, num_iterations);
}
source

pub fn as_f32(&self) -> f32

return progress as f32

source

pub fn as_f64(&self) -> f64

return progress as f64

Methods from Deref<Target = f64>§

1.43.0 · source

pub const RADIX: u32 = 2u32

1.43.0 · source

pub const MANTISSA_DIGITS: u32 = 53u32

1.43.0 · source

pub const DIGITS: u32 = 15u32

1.43.0 · source

pub const EPSILON: f64 = 2.2204460492503131E-16f64

1.43.0 · source

pub const MIN: f64 = -1.7976931348623157E+308f64

1.43.0 · source

pub const MIN_POSITIVE: f64 = 2.2250738585072014E-308f64

1.43.0 · source

pub const MAX: f64 = 1.7976931348623157E+308f64

1.43.0 · source

pub const MIN_EXP: i32 = -1_021i32

1.43.0 · source

pub const MAX_EXP: i32 = 1_024i32

1.43.0 · source

pub const MIN_10_EXP: i32 = -307i32

1.43.0 · source

pub const MAX_10_EXP: i32 = 308i32

1.43.0 · source

pub const NAN: f64 = NaNf64

1.43.0 · source

pub const INFINITY: f64 = +Inff64

1.43.0 · source

pub const NEG_INFINITY: f64 = -Inff64

1.62.0 · source

pub fn total_cmp(&self, other: &f64) -> Ordering

Return the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

  • negative quiet NaN
  • negative signaling NaN
  • negative infinity
  • negative numbers
  • negative subnormal numbers
  • negative zero
  • positive zero
  • positive subnormal numbers
  • positive numbers
  • positive infinity
  • positive signaling NaN
  • positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f64. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example
struct GoodBoy {
    name: String,
    weight: f64,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

Trait Implementations§

source§

impl Clone for Progress

source§

fn clone(&self) -> Progress

Returns a copy 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 Progress

source§

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

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

impl Default for Progress

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Deref for Progress

§

type Target = f64

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<T: Into<f64>> From<T> for Progress

source§

fn from(t: T) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Progress> for Progress

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Progress

source§

impl StructuralPartialEq for Progress

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.