Struct Instrument 

#[non_exhaustive]
pub struct Instrument {

    pub symbol: String,
    pub description: Option<String>,
    pub exchange: Option<String>,
    pub logo: Option<String>,
    pub exchange_logo: Option<String>,
    pub country: Option<String>,
    pub root: Option<String>,
    pub symbol_type: Option<SymbolType>,
    pub tick_size: Option<f64>,
    pub pip_size: Option<f64>,
    pub price_decimals: Option<u8>,
    pub volume_decimals: Option<u8>,
    pub currency: Option<String>,
    pub unit: Option<String>,
    pub time_zone: Option<TimezoneId>,
    pub session: Option<Session>,
    pub native_timeframes: Option<Vec<Timeframe>>,
    pub supported_timeframes: Option<Vec<Timeframe>>,
    pub services: Option<Vec<FeedService>>,
    pub data_status: Option<DataStatus>,
    pub dividend_adjustment: bool,
    pub profile_resolutions: Vec<ProfileResolution>,
}

What a feed or a search service reports about a symbol. Build it with Instrument::new and the with_ setters; fields left out stay unknown.

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.

symbol: String

The symbol as the feed knows it.

description: Option<String>

Full name, such as “Apple Inc.”.

exchange: Option<String>

Exchange or venue, such as “NASDAQ”.

logo: Option<String>

URI of the symbol’s logo for egui’s installed image loaders; supply a square image. The legend and symbol choosers draw it in a circle, and the symbol’s first letter or digit while it is unknown, loading or unreadable. A prefixed symbol such as VENUE:ABC shows V.

exchange_logo: Option<String>

URI of the exchange’s mark, for egui’s installed image loaders. Symbol search shows the exchange name alone while it is unknown, loading or unreadable.

country: Option<String>

Country of the listing, as an ISO 3166-1 alpha-2 code such as “US”.

root: Option<String>

Root shared by related instruments, such as “ES” for the contracts of a futures root or one security listed on several exchanges. Symbol search lists the first instrument of a root and offers the others under it.

symbol_type: Option<SymbolType>

Instrument type.

tick_size: Option<f64>

Smallest price increment: positive and finite. Consumers ignore any other value.

pip_size: Option<f64>

Price represented by one pip: positive and finite. Unknown for instruments without pips.

price_decimals: Option<u8>

Decimals of price labels.

volume_decimals: Option<u8>

Decimals of volume readouts, including abbreviated K/M/B values.

currency: Option<String>

Currency of prices, such as “USD”.

unit: Option<String>

Host-supplied price unit, such as “USD/barrel”; no conversion is performed.

time_zone: Option<TimezoneId>

Exchange time zone.

session: Option<Session>

Regular trading hours, in exchange time.

native_timeframes: Option<Vec<Timeframe>>

OHLCV intervals supplied without aggregation. None means unspecified; an empty list means no native bar history. Derived intervals remain available through host resampling.

supported_timeframes: Option<Vec<Timeframe>>

Intervals Datafeed::history answers, native or derived. None allows every interval. A chart does not ask the feed for any other interval. Pass the list to ui::top_toolbar::TimeframeSelector::set_supported_timeframes so that the interval picker offers only these.

services: Option<Vec<FeedService>>

Optional services supplied for this symbol, narrowing the feed’s services. None defers to the feed’s list; an empty list supplies none. Use FeedCapabilities::declares to require explicit confirmation from either list while respecting both.

data_status: Option<DataStatus>

How current the feed’s data is. The legend marks delayed and end-of-day data.

dividend_adjustment: bool

Whether the feed supplies dividend-adjusted history when HistoryRequest::adjusted is set.

profile_resolutions: Vec<ProfileResolution>

Bar intervals the feed suggests for volume profile studies and drawings, by profile length. A study whose source follows the chart, or a fixed range or anchored drawing without executions, reads the shortest suggested interval shorter than the chart’s that serves its length. Empty, the default, suggests none; profiles then spread each chart bar’s volume over its range.

Implementations

impl Instrument

pub fn new(symbol: impl Into<String>) -> Self

symbol, with everything else unknown.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets description.

pub fn with_unit(self, unit: impl Into<String>) -> Self

Sets the price unit.

pub fn with_exchange(self, exchange: impl Into<String>) -> Self

Sets exchange.

pub fn with_logo(self, uri: impl Into<String>) -> Self

Sets logo.

pub fn with_exchange_logo(self, uri: impl Into<String>) -> Self

Sets exchange_logo.

pub fn with_country(self, country: impl Into<String>) -> Self

Sets country.

pub fn with_root(self, root: impl Into<String>) -> Self

Sets root.

pub fn with_symbol_type(self, symbol_type: SymbolType) -> Self

Sets symbol_type.

pub fn with_tick_size(self, tick_size: f64) -> Self

Sets tick_size.

pub fn with_pip_size(self, pip_size: f64) -> Self

Sets pip_size.

pub fn with_price_decimals(self, decimals: u8) -> Self

Sets price_decimals.

pub fn with_volume_decimals(self, decimals: u8) -> Self

Sets volume_decimals.

pub fn with_currency(self, currency: impl Into<String>) -> Self

Sets currency.

pub fn with_time_zone(self, time_zone: TimezoneId) -> Self

Sets time_zone.

pub fn with_session(self, session: Session) -> Self

Sets session.

pub fn with_native_timeframes( self, timeframes: impl IntoIterator<Item = Timeframe>, ) -> Self

Sets native_timeframes, reported by Datafeed::resolve.

pub fn with_supported_timeframes( self, timeframes: impl IntoIterator<Item = Timeframe>, ) -> Self

Sets supported_timeframes.

pub fn with_services( self, services: impl IntoIterator<Item = FeedService>, ) -> Self

Sets services.

pub fn with_dividend_adjustment(self, adjustment: bool) -> Self

Sets dividend_adjustment.

pub fn with_data_status(self, status: DataStatus) -> Self

Sets data_status.

pub fn with_profile_resolutions( self, resolutions: impl IntoIterator<Item = ProfileResolution>, ) -> Self

Sets profile_resolutions.

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl PartialEq for Instrument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instrument