Skip to main content

AlertFeed

Struct AlertFeed 

Source
pub struct AlertFeed { /* private fields */ }
Expand description

Historical and streaming inputs for an alert without a rendered chart. Uses the same validation, trade aggregation and history/live merge rules as a chart. Dropping it stops its subscription and discards late replies. Available with alert-engine.

Implementations§

Source§

impl AlertFeed

Source

pub fn history_request( symbol: impl Into<String>, timeframe: Timeframe, ) -> HistoryRequest

A latest-history request for 1,000 bars. Set its public calendar, session, conversion and count fields before passing it to new to match the source chart.

Source

pub fn new( feed: Arc<dyn Datafeed>, request: HistoryRequest, metric: Option<String>, ) -> Self

Requests the symbol’s metadata, then its history and updates. metric selects a study’s metric series; None selects price bars. Calls return promptly as Datafeed requires.

Source

pub fn set_storage(&mut self, storage: Arc<dyn Storage>)

Follows this symbol’s drawings in host storage, without writing to it.

Source

pub fn bars(&self) -> &[Bar]

Bars available once history reaches the requested count or its end. Live updates stay buffered until then so evaluation never mistakes an incomplete stream for history.

Source

pub fn require_start(&mut self, start: DateTime<Utc>)

Extend coverage to start, even when it needs more than the initial bar count.

Source

pub fn clock(&self) -> &BarClock

Calendar shared by history, streaming aggregation and study calculation.

Source

pub fn instrument(&self) -> Option<&Instrument>

Metadata resolved by the host.

Source

pub fn drawing_value( &self, source: &AlertSource, at: usize, scale: PriceScaleMode, ) -> Option<f64>

A stored drawing’s level on the evaluated bar, using the chart’s interpolation and price-scale geometry. None while drawings are loading or for an unavailable level.

Source

pub fn poll(&mut self, ctx: &Context, now: DateTime<Utc>) -> Vec<FeedError>

Applies replies and coalesced updates and wakes ctx when more arrive. Recoverable failures retry after the host’s delay, or five seconds. Errors are returned for display.

Trait Implementations§

Source§

impl Drop for AlertFeed

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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, 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, 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.