Skip to main content

FeedCapabilities

Struct FeedCapabilities 

Source
#[non_exhaustive]
pub struct FeedCapabilities { pub timeframes: Option<Vec<Timeframe>>, pub exchanges: Option<Vec<String>>, pub symbol_types: Option<Vec<SymbolType>>, pub services: Option<Vec<FeedService>>, }
Expand description

What a feed offers as a whole, answered by Datafeed::capabilities. Each list distinguishes None, which the feed does not report and so restricts nothing, from Some of an empty list, which it reports as offering none. Use declares when a service needs explicit confirmation.

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.
§timeframes: Option<Vec<Timeframe>>

Intervals Datafeed::history answers for at least some symbol. A symbol’s own supported_timeframes narrows them further.

§exchanges: Option<Vec<String>>

Exchanges whose symbols the feed serves.

§symbol_types: Option<Vec<SymbolType>>

Classes of symbol the feed serves.

§services: Option<Vec<FeedService>>

Optional services the feed supplies for at least some symbol. A symbol’s own services narrows them further. Services absent from a reported list are unavailable.

Implementations§

Source§

impl FeedCapabilities

Source

pub fn new() -> Self

Reports no capability, which restricts nothing.

Source

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

Sets timeframes.

Source

pub fn with_exchanges(self, exchanges: impl IntoIterator<Item = String>) -> Self

Sets exchanges.

Source

pub fn with_symbol_types( self, types: impl IntoIterator<Item = SymbolType>, ) -> Self

Source

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

Sets services.

Source

pub fn offers(&self, service: FeedService) -> bool

Whether to offer the controls of service: it is listed, or the feed reports no list.

Source

pub fn declares(&self, service: FeedService, instrument: &Instrument) -> bool

Whether service is explicitly reported for instrument. Its own list takes precedence; without one, the feed’s list applies. A reported feed list must also include the service. With neither list reported, this returns false, unlike offers.

Trait Implementations§

Source§

impl Clone for FeedCapabilities

Source§

fn clone(&self) -> FeedCapabilities

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 Debug for FeedCapabilities

Source§

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

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

impl Default for FeedCapabilities

Source§

fn default() -> FeedCapabilities

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

impl PartialEq for FeedCapabilities

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FeedCapabilities

Auto Trait Implementations§

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
§

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,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> MaybeSend for T
where T: Send + Sync + ?Sized,

§

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

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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 = Infallible

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.