Skip to main content

AlertsPanel

Struct AlertsPanel 

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

An alert panel connected to the host’s Alerts service.

Call poll each frame even while hidden, so triggers produce notifications. Creation returns an intent to open the shared alert dialog. Only host pushes change the list; successful saves and removals never invent local state. Accounts, evaluation and delivery outside the application remain the host’s responsibility.

Implementations§

Source§

impl AlertsPanel

Source

pub fn new(config: AlertsPanelConfig) -> Self

Create an unconnected panel. Attach a service with set_service.

Source

pub fn set_symbol(&mut self, symbol: &str)

Start the Quick alert form on symbol, such as the chart’s. Call it every frame: the form follows a change of symbol and keeps what the user typed otherwise.

Source

pub fn set_sources(&mut self, sources: Vec<(AlertSource, String)>)

Offer these study outputs and drawings, as stable identifiers and display names, to the inline alert form.

Source

pub fn set_inputs(&mut self, inputs: AlertInputs, timeframe: Option<Timeframe>)

Creation inputs for the inline form, captured from its source view by the host.

Source

pub fn set_notification_seconds(&mut self, seconds: f32)

Keep each trigger notification on screen for this many seconds, five by default.

Source

pub fn set_sound(&mut self, sound: Option<String>)

The sound to play when an alert fires, as the user chose it in the alert settings: its name, empty for the host’s first sound, or None when the user turned the sound off.

Source

pub fn take_sound(&mut self) -> Option<String>

The sound to play for the triggers the last poll received, if it received one and set_sound holds a sound. The host plays it, as with Trading::take_execution_sound; call this after poll.

Source

pub fn set_service(&mut self, service: Arc<dyn Alerts>)

Attach a host service, clearing the previous account’s alerts and log.

Source

pub fn alerts(&self) -> &[Alert]

The latest alerts supplied by the host.

Source

pub fn log(&self) -> &VecDeque<AlertTrigger>

The most recent 10,000 host triggers in arrival order.

Source

pub fn save(&mut self, alert: Alert)

Save an alert from the shared dialog. The list changes only after a host push.

Source

pub fn poll(&mut self, ctx: &Context, toasts: &mut Toasts)

Drain service pushes and replies, recover a lagged stream, and append trigger notifications. Render toasts once per frame with the host’s other notifications.

Source

pub fn log_csv(&self) -> String

Export the retained trigger log. Text fields are quoted and embedded quotes doubled.

Source

pub fn show(&mut self, ui: &mut Ui) -> AlertPanelAction

Render the host’s alerts or trigger log after poll, returning creation or export intents.

Trait Implementations§

Source§

impl Default for AlertsPanel

Source§

fn default() -> Self

Returns the “default value” for a type. 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.