Struct SimpleReturn 

pub struct SimpleReturn { /* private fields */ }

A finite simple return value.

Implementations

impl SimpleReturn

pub fn new(value: f64) -> Result<SimpleReturn, ReturnError>

Creates a simple return from a finite value.

Errors

Returns [ReturnError::NonFiniteReturn] when value is not finite.

pub fn from_prices( start_price: f64, end_price: f64, ) -> Result<SimpleReturn, ReturnError>

Computes a simple return as end_price / start_price - 1.0.

Errors

Returns [ReturnError] when either price is not finite, the start price is not positive, or the end price is negative.

pub const fn value(self) -> f64

Returns the stored return value.

Trait Implementations

impl Clone for SimpleReturn

fn clone(&self) -> SimpleReturn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleReturn

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

Formats the value using the given formatter.

impl Display for SimpleReturn

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

Formats the value using the given formatter.

impl PartialEq for SimpleReturn

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

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

impl StructuralPartialEq for SimpleReturn