Struct MethodologyMetadata 

#[non_exhaustive]
pub struct MethodologyMetadata {
    pub api_version: Cow<'static, str>,
    pub profile_version: Cow<'static, str>,
    pub profile_kind: FinanceProfileKind,
    pub sampling: SamplingCadence,
    pub lookback_periods: usize,
    pub input_centering: FinanceInputCentering,
    pub transform: TransformSpec,
    pub boundary: Option<BoundaryModeSpec>,
    pub wavelet: WaveletSpec,
    pub requested_levels: Option<usize>,
}

Methodology metadata attached to finance signal outputs.

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.

api_version: Cow<'static, str>

Finance API contract version.

profile_version: Cow<'static, str>

Methodology profile version.

profile_kind: FinanceProfileKind

Profile family.

sampling: SamplingCadence

Input sampling cadence.

lookback_periods: usize

Input lookback actually requested.

input_centering: FinanceInputCentering

Centering applied to finite observations before the transform ran.

transform: TransformSpec

Transform selector.

boundary: Option<BoundaryModeSpec>

Boundary mode selected by the transform, when applicable.

wavelet: WaveletSpec

Wavelet selector.

requested_levels: Option<usize>

Requested decomposition levels.

Implementations

impl MethodologyMetadata

pub fn from_profile(profile: &FinanceProfile) -> Self

Construct metadata from a validated profile.

Trait Implementations

impl Clone for MethodologyMetadata

fn clone(&self) -> MethodologyMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MethodologyMetadata

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

Formats the value using the given formatter.

impl PartialEq for MethodologyMetadata

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