redfolder 1.0.0

Async economic calendar client and automated trading blackout engine for algorithmic traders and prop firms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! # redfolder
//!
//! Async economic calendar client and automated trading blackout engine for algorithmic traders and prop firms.
//!
//! `redfolder` monitors high-impact macroeconomic releases (ForexFactory / FairEconomy calendar)
//! and calculates dynamic trading blackout windows, protecting algorithmic bots and prop firm accounts
//! against sudden spread spikes and slippage.

pub mod calendar;
pub mod config;
pub mod curfew;
pub mod engine;
pub mod error;
pub mod events;
pub mod service;
pub mod types;

pub use calendar::{
    CacheMetadata, CachedCalendarData, CalendarClient, RawCalendarEvent, CALENDAR_URL,
    DEFAULT_CACHE_FILENAME,
};
pub use config::{RedFolderConfig, RedFolderConfigBuilder};
pub use curfew::{
    next_weekend_window, parse_time, weekend_window_at, weekend_window_for_mode,
    weekend_window_title, weekend_window_title_for_mode, WeekendMode,
};
pub use engine::{
    current_window_for_config, event_matches_config, event_matches_economic_event,
    find_window_binary_search, is_blackout_for_config, BlackoutEngine,
};
pub use error::{RedFolderError, Result};
pub use events::{EventListener, RedFolderEvent};
pub use service::RedFolderService;
pub use types::{
    BlackoutNotification, BlackoutWindow, Currency, CustomEventKind, EconomicEvent, EventTiming,
    FailSafeMode, Impact, WindowEvent,
};

/// Common prelude items for quick import.
pub mod prelude {
    pub use crate::config::{RedFolderConfig, RedFolderConfigBuilder};
    pub use crate::curfew::WeekendMode;
    pub use crate::engine::BlackoutEngine;
    pub use crate::error::{RedFolderError, Result};
    pub use crate::events::{EventListener, RedFolderEvent};
    pub use crate::service::{RedFolderService, ServiceState};
    pub use crate::types::{
        BlackoutNotification, BlackoutWindow, Currency, CustomEventKind, EventTiming, FailSafeMode,
        Impact, WindowEvent,
    };
}