Skip to main content

StationBuilder

Struct StationBuilder 

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

Fluent builder for Station.

Implementations§

Source§

impl StationBuilder

Source

pub fn new() -> Self

Source

pub fn storage_root(self, root: impl Into<PathBuf>) -> Self

Override the root directory under which all Station-managed artefacts (trades, bars, snapshots, indexes) are written.

Source

pub fn persistence(self, cfg: PersistenceConfig) -> Self

Configure trade/bar/snapshot persistence.

Source

pub fn warm_start(self, n: usize) -> Self

Number of most-recent points to emit from disk on subscribe BEFORE live stream takes over. 0 disables warm-start. Acts as the in-memory series capacity too.

Source

pub fn gap_heal(self, cfg: GapHealConfig) -> Self

Configure proactive gap-heal: when a live event arrives whose timestamp jumps further than the configured threshold past the last seen event, the station REST-backfills the missing window before emitting the live event. Off by default.

On wasm32 the REST pull uses browser fetch; it succeeds for the 9 proxy-override venues (Binance/Bybit/OKX/Bitget/Bitstamp/Coinbase/Kraken/ Deribit/HTX) and silently returns an empty window for other venues until their REST CORS proxies are wired (Wave 4-C).

Source

pub fn unsubscribe_grace(self, grace: Duration) -> Self

How long to keep a WS forwarder alive after its last consumer drops. During this window a new subscription for the same key reuses the live connection — no reconnect, no REST re-seed.

Default: Duration::ZERO (immediate drop, current behaviour).

Typical UI value: Duration::from_secs(30) so a quick symbol-flip (BTC → ETH → BTC) stays on the same socket.

Source

pub fn orderbook_rest_seed(self, enable: bool) -> Self

On first subscribe to an [Stream::Orderbook] or [Stream::OrderbookDelta] stream for a (exchange, symbol, account) key, also issue a one-shot REST get_orderbook call so the live book is seeded with up to depth levels before WS deltas start applying.

Default: false (WS-only — matches pre-0.3.13 behaviour).

On failure (REST not connected, exchange returns error, empty snapshot) the station continues with WS-only and logs a warning. Never aborts the subscribe.

Source

pub fn orderbook_seed_depth(self, depth: usize) -> Self

Depth of the REST seed snapshot. Only meaningful when Self::orderbook_rest_seed is true.

Passed directly to get_orderbook(symbol, Some(depth as u16), account). Clamped to 1..=u16::MAX internally.

Default: 1000.

Source

pub async fn build(self) -> Result<Station>

Trait Implementations§

Source§

impl Debug for StationBuilder

Source§

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

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

impl Default for StationBuilder

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
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<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more