FinanceSignalQuality

Struct FinanceSignalQuality 

#[non_exhaustive]
pub struct FinanceSignalQuality { pub status: FinanceSignalStatus, pub observations: Option<FinanceObservationMetadata>, pub levels: FinanceLevelMetadata, pub elapsed_micros: Option<u64>, pub diagnostics: Vec<FinanceDiagnostic>, }
Expand description

Shared quality metadata carried by every finance signal envelope.

Fields (Non-exhaustive)§

This struct is marked as 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.
§status: FinanceSignalStatus

Contract status for this signal.

§observations: Option<FinanceObservationMetadata>

Input/count metadata when known.

§levels: FinanceLevelMetadata

Decomposition-level metadata.

§elapsed_micros: Option<u64>

Runtime duration in microseconds when measured by the caller. This is a plain integer rather than Duration to keep the wire contract explicit.

§diagnostics: Vec<FinanceDiagnostic>

Structured diagnostics and reliability ingredients.

Implementations§

§

impl FinanceSignalQuality

pub fn computed() -> Self

Quality metadata for a fully computed signal.

pub fn unavailable(status: FinanceSignalStatus) -> Self

Quality metadata for a non-computed signal status.

pub fn new(status: FinanceSignalStatus) -> Self

Create quality metadata with a specific status.

pub fn with_observations(self, observations: FinanceObservationMetadata) -> Self

Attach observation counts.

pub fn with_elapsed_micros(self, elapsed_micros: u64) -> Self

Attach runtime duration.

pub fn with_diagnostic(self, diagnostic: FinanceDiagnostic) -> Self

Attach a diagnostic.

pub fn with_levels( self, requested_levels: Option<usize>, computed_levels: Option<usize>, reduced_reason: Option<String>, ) -> Self

Attach reduced-level metadata and degrade computed status when needed. Repeated calls replace the previous reduced_levels diagnostic. A reduced computed signal becomes degraded; unavailable, insufficient, and failed statuses keep their original status.

Trait Implementations§

§

impl Clone for FinanceSignalQuality

§

fn clone(&self) -> FinanceSignalQuality

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
§

impl Debug for FinanceSignalQuality

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for FinanceSignalQuality

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0§

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 Eq for FinanceSignalQuality

§

impl StructuralPartialEq for FinanceSignalQuality

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> IntoEither for T

§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,