digdigdig3-station 0.3.4

Consumer-facing builder over digdigdig3 ExchangeHub. Persistence, cache, replay, cure, orderbook tracker, multiplex, reconnect.
Documentation
use std::path::PathBuf;

use crate::{GapHealConfig, PersistenceConfig, Result, Station};

/// Fluent builder for [`Station`].
#[derive(Debug)]
pub struct StationBuilder {
    pub(crate) storage_root: PathBuf,
    pub(crate) persistence: PersistenceConfig,
    pub(crate) warm_start: usize,
    pub(crate) gap_heal: GapHealConfig,
}

impl Default for StationBuilder {
    fn default() -> Self {
        let env_root = std::env::var_os("DIG3_STORAGE_ROOT").map(PathBuf::from);
        Self {
            storage_root: env_root.unwrap_or_else(|| PathBuf::from("./dig3_storage")),
            persistence: PersistenceConfig::default(),
            warm_start: 0,
            gap_heal: GapHealConfig::default(),
        }
    }
}

impl StationBuilder {
    pub fn new() -> Self { Self::default() }

    /// Override the root directory under which all Station-managed artefacts
    /// (trades, bars, snapshots, indexes) are written.
    pub fn storage_root(mut self, root: impl Into<PathBuf>) -> Self {
        self.storage_root = root.into();
        self
    }

    /// Configure trade/bar/snapshot persistence.
    pub fn persistence(mut self, cfg: PersistenceConfig) -> Self {
        self.persistence = cfg;
        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.
    pub fn warm_start(mut self, n: usize) -> Self {
        self.warm_start = n;
        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.
    pub fn gap_heal(mut self, cfg: GapHealConfig) -> Self {
        self.gap_heal = cfg;
        self
    }

    pub async fn build(self) -> Result<Station> {
        Station::from_builder(self).await
    }
}