Skip to main content

SummaryDetail

finance_query::quote

Struct SummaryDetail 

Source 
#[non_exhaustive]
pub struct SummaryDetail<F: Format = Both> {
Show 57 fields
    pub algorithm: Option<Value>,
    pub all_time_high: Option<F::Value<f64>>,
    pub all_time_low: Option<F::Value<f64>>,
    pub ask: Option<F::Value<f64>>,
    pub ask_size: Option<F::Value<i64>>,
    pub average_daily_volume10_day: Option<F::Value<i64>>,
    pub average_volume: Option<F::Value<i64>>,
    pub average_volume10days: Option<F::Value<i64>>,
    pub beta: Option<F::Value<f64>>,
    pub bid: Option<F::Value<f64>>,
    pub bid_size: Option<F::Value<i64>>,
    pub circulating_supply: Option<Value>,
    pub coin_market_cap_link: Option<Value>,
    pub currency: Option<String>,
    pub day_high: Option<F::Value<f64>>,
    pub day_low: Option<F::Value<f64>>,
    pub dividend_rate: Option<F::Value<f64>>,
    pub dividend_yield: Option<F::Value<f64>>,
    pub ex_dividend_date: Option<F::Value<i64>>,
    pub expire_date: Option<Value>,
    pub fifty_day_average: Option<F::Value<f64>>,
    pub fifty_two_week_high: Option<F::Value<f64>>,
    pub fifty_two_week_low: Option<F::Value<f64>>,
    pub five_year_avg_dividend_yield: Option<F::Value<f64>>,
    pub forward_pe: Option<F::Value<f64>>,
    pub from_currency: Option<String>,
    pub last_market: Option<String>,
    pub market_cap: Option<F::Value<i64>>,
    pub max_age: Option<i64>,
    pub max_supply: Option<Value>,
    pub nav_price: Option<F::Value<f64>>,
    pub open: Option<F::Value<f64>>,
    pub open_interest: Option<Value>,
    pub payout_ratio: Option<F::Value<f64>>,
    pub previous_close: Option<F::Value<f64>>,
    pub price_hint: Option<F::Value<i64>>,
    pub price_to_sales_trailing12_months: Option<F::Value<f64>>,
    pub qtd_return: Option<Value>,
    pub regular_market_day_high: Option<F::Value<f64>>,
    pub regular_market_day_low: Option<F::Value<f64>>,
    pub regular_market_open: Option<F::Value<f64>>,
    pub regular_market_previous_close: Option<F::Value<f64>>,
    pub regular_market_volume: Option<F::Value<i64>>,
    pub start_date: Option<Value>,
    pub strike_price: Option<Value>,
    pub to_currency: Option<String>,
    pub total_assets: Option<F::Value<i64>>,
    pub tradeable: Option<bool>,
    pub trailing_annual_dividend_rate: Option<F::Value<f64>>,
    pub trailing_annual_dividend_yield: Option<F::Value<f64>>,
    pub trailing_pe: Option<F::Value<f64>>,
    pub two_hundred_day_average: Option<F::Value<f64>>,
    pub volume: Option<F::Value<i64>>,
    pub volume24_hr: Option<Value>,
    pub volume_all_currencies: Option<Value>,
    pub yield_value: Option<F::Value<f64>>,
    pub ytd_return: Option<Value>,

}
Expand description

Summary detail trading and valuation metrics

Contains detailed information about price, volume, market cap, and other trading data.

The type parameter F controls how numeric fields are represented:

  • SummaryDetail / SummaryDetail<Both> — default; fields hold FormattedValue<T>
  • SummaryDetail<Raw> — fields hold T directly (e.g. Option<f64>)
  • SummaryDetail<Pretty> — fields hold Option<String> (human-readable)

Obtain converted views via Quote::as_raw or call .as_raw() / .into_raw() on a SummaryDetail<Both> directly.

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.
§algorithm: Option<Value>

Algorithm (for crypto/special assets)

§all_time_high: Option<F::Value<f64>>

All-time high price

§all_time_low: Option<F::Value<f64>>

All-time low price

§ask: Option<F::Value<f64>>

Current ask price

§ask_size: Option<F::Value<i64>>

Ask size (shares)

§average_daily_volume10_day: Option<F::Value<i64>>

Average daily trading volume (10 day)

§average_volume: Option<F::Value<i64>>

Average trading volume

§average_volume10days: Option<F::Value<i64>>

Average trading volume (10 days)

§beta: Option<F::Value<f64>>

Beta coefficient (volatility vs market)

§bid: Option<F::Value<f64>>

Current bid price

§bid_size: Option<F::Value<i64>>

Bid size (shares)

§circulating_supply: Option<Value>

Circulating supply (for crypto)

§coin_market_cap_link: Option<Value>

CoinMarketCap link (for crypto)

§currency: Option<String>

Currency code

§day_high: Option<F::Value<f64>>

Day’s high price

§day_low: Option<F::Value<f64>>

Day’s low price

§dividend_rate: Option<F::Value<f64>>

Annual dividend rate

§dividend_yield: Option<F::Value<f64>>

Dividend yield percentage

§ex_dividend_date: Option<F::Value<i64>>

Ex-dividend date

§expire_date: Option<Value>

Expiration date (for options/futures)

§fifty_day_average: Option<F::Value<f64>>

50-day moving average

§fifty_two_week_high: Option<F::Value<f64>>

52-week high price

§fifty_two_week_low: Option<F::Value<f64>>

52-week low price

§five_year_avg_dividend_yield: Option<F::Value<f64>>

5-year average dividend yield

§forward_pe: Option<F::Value<f64>>

Forward price-to-earnings ratio

§from_currency: Option<String>

From currency (for currency pairs)

§last_market: Option<String>

Last market (for crypto)

§market_cap: Option<F::Value<i64>>

Market capitalization

§max_age: Option<i64>

Maximum age of data in seconds

§max_supply: Option<Value>

Maximum supply (for crypto)

§nav_price: Option<F::Value<f64>>

Net asset value price (for funds)

§open: Option<F::Value<f64>>

Opening price

§open_interest: Option<Value>

Open interest (for options/futures)

§payout_ratio: Option<F::Value<f64>>

Dividend payout ratio

§previous_close: Option<F::Value<f64>>

Previous closing price

§price_hint: Option<F::Value<i64>>

Price hint (decimal places)

§price_to_sales_trailing12_months: Option<F::Value<f64>>

Price to sales ratio (trailing 12 months)

§qtd_return: Option<Value>

Quarter-to-date return

§regular_market_day_high: Option<F::Value<f64>>

Regular market day high

§regular_market_day_low: Option<F::Value<f64>>

Regular market day low

§regular_market_open: Option<F::Value<f64>>

Regular market opening price

§regular_market_previous_close: Option<F::Value<f64>>

Regular market previous close

§regular_market_volume: Option<F::Value<i64>>

Regular market trading volume

§start_date: Option<Value>

Start date (for funds/special assets)

§strike_price: Option<Value>

Strike price (for options)

§to_currency: Option<String>

To currency (for currency pairs)

§total_assets: Option<F::Value<i64>>

Total assets (for funds)

§tradeable: Option<bool>

Whether the security is tradeable

§trailing_annual_dividend_rate: Option<F::Value<f64>>

Trailing annual dividend rate

§trailing_annual_dividend_yield: Option<F::Value<f64>>

Trailing annual dividend yield

§trailing_pe: Option<F::Value<f64>>

Trailing price-to-earnings ratio

§two_hundred_day_average: Option<F::Value<f64>>

200-day moving average

§volume: Option<F::Value<i64>>

Trading volume

§volume24_hr: Option<Value>

24-hour trading volume (for crypto)

§volume_all_currencies: Option<Value>

Volume across all currencies (for crypto)

§yield_value: Option<F::Value<f64>>

Yield (for bonds/funds)

§ytd_return: Option<Value>

Year-to-date return

Implementations§

Source§

impl SummaryDetail<Both>

Source

pub fn into_raw(self) -> SummaryDetail<Raw>

Convert into a Raw view, extracting .raw from each FormattedValue field.

Source

pub fn as_raw(&self) -> SummaryDetail<Raw>

Clone and convert into a Raw view.

Source

pub fn into_pretty(self) -> SummaryDetail<Pretty>

Convert into a Pretty view, extracting .fmt from each FormattedValue field.

Source

pub fn as_pretty(&self) -> SummaryDetail<Pretty>

Clone and convert into a Pretty view.

Trait Implementations§

Source§

impl<F: Clone + Format> Clone for SummaryDetail<F>
where F::Value<f64>: Clone, F::Value<i64>: Clone,

Source§

fn clone(&self) -> SummaryDetail<F>

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<F: Debug + Format> Debug for SummaryDetail<F>
where F::Value<f64>: Debug, F::Value<i64>: Debug,

Source§

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

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

impl<F: Default + Format> Default for SummaryDetail<F>
where F::Value<f64>: Default, F::Value<i64>: Default,

Source§

fn default() -> SummaryDetail<F>

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

impl<'de, F: Format> Deserialize<'de> for SummaryDetail<F>

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 From<SummaryDetail> for SummaryDetail<Raw>

Source§

fn from(v: SummaryDetail<Both>) -> Self

Converts to this type from the input type.
Source§

impl From<SummaryDetail> for SummaryDetail<Pretty>

Source§

fn from(v: SummaryDetail<Both>) -> Self

Converts to this type from the input type.
Source§

impl<F: PartialEq + Format> PartialEq for SummaryDetail<F>
where F::Value<f64>: PartialEq, F::Value<i64>: PartialEq,

Source§

fn eq(&self, other: &SummaryDetail<F>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<F: Format> Serialize for SummaryDetail<F>

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<F: PartialEq + Format> StructuralPartialEq for SummaryDetail<F>
where F::Value<f64>: PartialEq, F::Value<i64>: PartialEq,

Source§

impl Translatable for SummaryDetail

Source§

fn visit_translatable(&mut self, visit: &mut dyn FnMut(&mut String))

Visit every translatable string field in a stable order.
Source§

fn after_translate(&mut self)

Hook invoked after translations have been written back, for types that maintain derived text (e.g. a transcript’s joined full text).

Auto Trait Implementations§

§

impl<F> Freeze for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: Freeze, Option<<F as Format>::Value<i64>>: Freeze,

§

impl<F> RefUnwindSafe for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: RefUnwindSafe, Option<<F as Format>::Value<i64>>: RefUnwindSafe,

§

impl<F> Send for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: Send, Option<<F as Format>::Value<i64>>: Send,

§

impl<F> Sync for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: Sync, Option<<F as Format>::Value<i64>>: Sync,

§

impl<F> Unpin for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: Unpin, Option<<F as Format>::Value<i64>>: Unpin,

§

impl<F> UnsafeUnpin for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: UnsafeUnpin, Option<<F as Format>::Value<i64>>: UnsafeUnpin,

§

impl<F> UnwindSafe for SummaryDetail<F>
where Option<<F as Format>::Value<f64>>: UnwindSafe, Option<<F as Format>::Value<i64>>: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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

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

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

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, <T as TryFrom<U>>::Error>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more