Struct DividendGapView 

pub struct DividendGapView {
    pub events: u32,
    pub strategy_income: f64,
    pub benchmark_income: f64,
    pub overstatement: f64,
    pub corrected_excess: Option<f64>,
    pub complete: bool,
    pub covered: u32,
    pub instruments: u32,
}

Fields

events: u32

Distributions that went ex inside the window.

Zero is a real answer and a good one: these instruments pay nothing, so the margin needs no correction.

strategy_income: f64

benchmark_income: f64

overstatement: f64

The gap as a fraction of starting capital, in the same units as the excess return it comes off.

corrected_excess: Option<f64>

The excess return with the gap taken out, where taking it out means anything.

None on a total-return dataset: the distributions are already in the excess return there, so subtracting the gap again would report a margin smaller than the account earned. The rest of this view still holds — only the subtraction stops being valid.

complete: bool

False when some instrument the run held has no distribution series, in which case the figure is a floor rather than the answer.

covered: u32

instruments: u32

Implementations

impl DividendGapView

pub fn corrected_excess(&self) -> f64

Returns the value of corrected_excess, or the default value if corrected_excess is unset.

Trait Implementations

impl Clone for DividendGapView

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DividendGapView

impl Debug for DividendGapView

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

Formats the value using the given formatter.

impl Default for DividendGapView

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DividendGapView

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for DividendGapView

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DividendGapView

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for DividendGapView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DividendGapView