Struct PositiveReal 

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

A f64 value that is not +/- inf, nan, or a value <= 0.

Example

use hoomd_utility::valid::PositiveReal;

let positive = PositiveReal::try_from(1.0)?;

Implementations

impl PositiveReal

pub fn get(&self) -> f64

Access the value.

Example

use hoomd_utility::valid::PositiveReal;

let positive = PositiveReal::try_from(1.0)?;

assert_eq!(positive.get(), 1.0);

Trait Implementations

impl Clone for PositiveReal

fn clone(&self) -> PositiveReal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveReal

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

Formats the value using the given formatter.

impl Default for PositiveReal

fn default() -> Self

The default value is 1.0.

impl<'de> Deserialize<'de> for PositiveReal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PositiveReal

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

Formats the value using the given formatter.

impl Div for PositiveReal

type Output = PositiveReal

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for PositiveReal

fn div_assign(&mut self, rhs: PositiveReal)

Performs the /= operation.

impl Mul for PositiveReal

type Output = PositiveReal

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for PositiveReal

fn mul_assign(&mut self, rhs: PositiveReal)

Performs the *= operation.

impl Ord for PositiveReal

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<f64> for PositiveReal

fn try_from(v: f64) -> Result<PositiveReal, Error>

Convert f64 to PositiveReal.

Example

Valid conversion:

use hoomd_utility::valid::PositiveReal;

let positive = PositiveReal::try_from(1.0)?;

Invalid conversion

use hoomd_utility::valid::PositiveReal;

let result = PositiveReal::try_from(-1.0);
assert!(matches!(
    result,
    Err(hoomd_utility::valid::Error::NotPositive(_))
));

Errors

Error::NotFinite when v is not finite. Error::NotPositive when v is not a positive value

type Error = Error

The type returned in the event of a conversion error.

impl Copy for PositiveReal

impl Eq for PositiveReal

impl StructuralPartialEq for PositiveReal