Struct FinanceSignal 

#[non_exhaustive]
pub struct FinanceSignal<T> {
    pub kind: FinanceSignalKind,
    pub quality: FinanceSignalQuality,
    pub methodology: MethodologyMetadata,
    pub payload: Option<T>,
}

Product-facing signal envelope.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: FinanceSignalKind

Signal family represented by the payload.

quality: FinanceSignalQuality

Shared quality/status metadata.

methodology: MethodologyMetadata

Methodology metadata.

payload: Option<T>

Product payload. Raw coefficient arrays are not part of default payloads.

Implementations

impl<T> FinanceSignal<T>

pub fn computed( kind: FinanceSignalKind, methodology: MethodologyMetadata, payload: T, ) -> Self

Create a computed signal envelope.

pub fn computed_with_quality( kind: FinanceSignalKind, methodology: MethodologyMetadata, payload: T, quality: FinanceSignalQuality, ) -> Result<Self>

Create a computed signal envelope with caller-supplied quality metadata.

pub fn empty_with_diagnostic( kind: FinanceSignalKind, status: FinanceSignalStatus, methodology: MethodologyMetadata, diagnostic: FinanceDiagnostic, ) -> Self

Create an empty non-computed signal envelope with one diagnostic.

pub fn empty( kind: FinanceSignalKind, status: FinanceSignalStatus, methodology: MethodologyMetadata, diagnostics: Vec<FinanceDiagnostic>, ) -> Self

Create an empty non-computed signal envelope with zero or more diagnostics.

impl<T> FinanceSignal<FinanceEventDetection<T>>

pub fn event_detected( kind: FinanceSignalKind, methodology: MethodologyMetadata, event: T, ) -> Self

Create a computed event-detection signal containing a detected event.

pub fn no_event( kind: FinanceSignalKind, methodology: MethodologyMetadata, ) -> Self

Create a computed event-detection signal where no event was found.

Trait Implementations

impl<T: Clone> Clone for FinanceSignal<T>

fn clone(&self) -> FinanceSignal<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FinanceSignal<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for FinanceSignal<T>

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