Struct OptionsChainStreamBuilder

Source

pub struct OptionsChainStreamBuilder { /* private fields */ }

Expand description

Builder for an OptionsChainStream.

Implementations§

Source §

impl OptionsChainStreamBuilder

Source

pub fn new() -> Self

Create a builder with no symbols and default timings.

Source

pub fn greeks_refresh(self, interval: Option<Duration>) -> Self

Interval between greeks/open-interest snapshot refreshes.

None disables them, leaving only WebSocket bid/ask/last (one REST call per underlying per interval otherwise). Default: 60s.

Source

pub async fn build(self) -> StreamResult<OptionsChainStream>

Build and start the stream.

Source §

impl OptionsChainStreamBuilder

Source

pub fn underlyings<S, I>(self, symbols: I) -> Self
where S: Into<String>, I: IntoIterator<Item = S>,

Add underlyings (or full OCC contract symbols) to follow.

Source

pub fn retry(self, delay: Duration) -> Self

Set the base delay before the first reconnection attempt (default: 3s). Later attempts grow exponentially from this, capped and jittered — see Self::max_reconnect_attempts to also cap how many attempts are made.

Source

pub fn max_reconnect_attempts(self, max: u32) -> Self

Cap the number of consecutive reconnect attempts before the stream gives up and ends (default: unlimited, i.e. retry forever).

Trait Implementations§

Source §

impl Default for OptionsChainStreamBuilder

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl UnwindSafe for OptionsChainStreamBuilder

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