Struct NicheBreadth 

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

Implementations

impl NicheBreadth

pub fn new(value: f64) -> Result<Self, NicheValueError>

Errors

Returns NicheValueError::NonFinite when value is not finite. Returns NicheValueError::Negative when value is less than zero.

pub const fn get(self) -> f64

Trait Implementations

impl Clone for NicheBreadth

fn clone(&self) -> NicheBreadth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NicheBreadth

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

Formats the value using the given formatter.

impl Display for NicheBreadth

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

Formats the value using the given formatter.

impl PartialEq for NicheBreadth

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

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

impl StructuralPartialEq for NicheBreadth