Struct MarketPrice 

pub struct MarketPrice { /* private fields */ }

A finite non-negative market price value.

Zero is accepted for descriptive use cases such as missing, halted, or placeholder prices. Positive prices can be checked with MarketPrice::is_positive.

Implementations

impl MarketPrice

pub fn new(value: f64) -> Result<MarketPrice, MarketPriceError>

Creates a market price from a finite non-negative f64.

Errors

Returns MarketPriceError::NonFinite for NaN or infinite values and MarketPriceError::Negative for negative values.

pub const fn value(self) -> f64

Returns the stored price value.

pub fn is_positive(self) -> bool

Returns whether the price is strictly positive.

Trait Implementations

impl Clone for MarketPrice

fn clone(&self) -> MarketPrice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MarketPrice

impl Debug for MarketPrice

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

Formats the value using the given formatter.

impl Display for MarketPrice

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

Formats the value using the given formatter.

impl PartialEq for MarketPrice

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

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

impl TryFrom<f64> for MarketPrice

type Error = MarketPriceError

The type returned in the event of a conversion error.

fn try_from( value: f64, ) -> Result<MarketPrice, <MarketPrice as TryFrom<f64>>::Error>

Performs the conversion.