Struct DrawdownPoint 

pub struct DrawdownPoint { /* private fields */ }

A drawdown point with an optional label.

Implementations

impl DrawdownPoint

pub const fn new(drawdown: Drawdown) -> DrawdownPoint

Creates an unlabeled drawdown point.

pub fn with_label( self, label: impl AsRef<str>, ) -> Result<DrawdownPoint, DrawdownError>

Attaches a non-empty label.

Errors

Returns [DrawdownError::EmptyLabel] when the trimmed label is empty.

pub fn label(&self) -> Option<&str>

Returns the optional label.

pub const fn drawdown(&self) -> Drawdown

Returns the drawdown.

Trait Implementations

impl Clone for DrawdownPoint

fn clone(&self) -> DrawdownPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DrawdownPoint

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

Formats the value using the given formatter.

impl PartialEq for DrawdownPoint

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