Struct strict_num::PositiveF32

#[repr(transparent)]
pub struct PositiveF32(pub(crate) FiniteF32);

An immutable, finite f32 that is known to be >= 0.

Tuple Fields

0: FiniteF32

Implementations

impl PositiveF32

pub const ZERO: Self = _

A PositiveF32 value initialized with zero.

pub fn new(n: f32) -> Option<Self>

Creates a new PositiveF32 if the given value is >= 0.

Returns None for negative, NaN and infinity.

pub const unsafe fn new_unchecked(n: f32) -> Self

Creates a new PositiveF32 without checking the value.

Safety

n must be finite and >= 0.

pub const fn get(&self) -> f32

Returns the value as a primitive type.

pub const fn get_finite(&self) -> FiniteF32

Returns the value as a FiniteF32.

Trait Implementations

impl Clone for PositiveF32

fn clone(&self) -> PositiveF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveF32

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

Formats the value using the given formatter.

impl Default for PositiveF32

fn default() -> PositiveF32

Returns the “default value” for a type.

impl Display for PositiveF32

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

Formats the value using the given formatter.

impl Hash for PositiveF32

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 PositiveF32

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

Restrict a value to a certain interval.

impl PartialEq<f32> for PositiveF32

fn eq(&self, other: &f32) -> 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 PartialEq for PositiveF32

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

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

impl Eq for PositiveF32

impl StructuralPartialEq for PositiveF32