Skip to main content

ReportedView

Struct ReportedView 

Source
pub struct ReportedView {
Show 21 fields pub id: String, pub hypothesis: String, pub claim: String, pub instrument: String, pub engine: String, pub from: String, pub to: String, pub interval: String, pub dataset: String, pub strategy: String, pub verdict: String, pub reasons: Vec<String>, pub trades: u32, pub trials: Option<u32>, pub total_return: Option<f64>, pub excess_return: Option<f64>, pub sharpe: Option<f64>, pub max_drawdown: Option<f64>, pub recorded_at: String, pub author: String, pub attachments: Vec<Attachment>,
}
Expand description

Every shape at the root as well, because a window names a view on nearly every line and arvo_api::research::StudyView would be noise. The names do not collide: proto has no overloading and neither does this. Every shape at the root as well, because a window names a view on nearly every line and arvo_api::research::StudyView would be noise. The names do not collide: proto has no overloading and neither does this. Every shape at the root as well, because a window names a view on nearly every line and arvo_api::research::StudyView would be noise. The names do not collide: proto has no overloading and neither does this. A finding an engine Arvo did not run computed, judged by Arvo (ADR-0026). Shown as what it is: the numbers and the verdict, and where the data lives.

Fields§

§id: String§hypothesis: String§claim: String§instrument: String§engine: String§from: String§to: String§interval: String§dataset: String

id@version: the engine’s own dataset, not in Arvo’s library.

§strategy: String§verdict: String§reasons: Vec<String>§trades: u32§trials: Option<u32>§total_return: Option<f64>

Absent when there was no benchmark to judge against.

§excess_return: Option<f64>§sharpe: Option<f64>§max_drawdown: Option<f64>§recorded_at: String§author: String§attachments: Vec<Attachment>

The files kept with it: a report, a figure, the trades (#157).

Implementations§

Source§

impl ReportedView

Source

pub fn trials(&self) -> u32

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

Source

pub fn total_return(&self) -> f64

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

Source

pub fn excess_return(&self) -> f64

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

Source

pub fn sharpe(&self) -> f64

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

Source

pub fn max_drawdown(&self) -> f64

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

Trait Implementations§

Source§

impl Clone for ReportedView

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReportedView

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReportedView

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ReportedView

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Message for ReportedView

Source§

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

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

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8> ⓘ
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

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

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘ
where Self: Sized,

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

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

Decodes an instance of the message from a buffer. Read more
Source§

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

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

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. Read more
Source§

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.
Source§

impl PartialEq for ReportedView

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ReportedView

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ReportedView

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.