optionchain_simulator 0.2.0

OptionChain-Simulator is a lightweight REST API service that simulates an evolving option chain with every request. It is designed for developers building or testing trading systems, backtesters, and visual tools that depend on option data streams but want to avoid relying on live data feeds.
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
52
53
54
55
56
57
58

/// This module, `in_memory`, provides functionality for managing and storing
/// data using an in-memory data structure. The specific implementation details
/// and use cases depend on the contents of the module, which may include data such as
/// caching, temporary storage, or other memory-based operations.
///
/// Use this module to store and retrieve transient data efficiently during runtime,
/// when persistence is not required.
///
/// Example usage:
/// - In-memory caching for frequently accessed data.
/// - Temporary storage during runtime processing.
/// - Simulating data storage mechanisms for testing purposes.
///
/// To fully understand its utility, refer to the specific implementations
/// and functions within the `in_memory` module.
mod in_memory;

/// The `in_redis` module is a logical grouping for code that interacts with Redis.
///
/// This module may contain functionalities such as:
/// - Establishing connections to a Redis database.
/// - Performing CRUD operations (e.g., setting and retrieving key-value pairs).
/// - Managing Redis-based caching mechanisms.
/// - Handling pub/sub messaging or other Redis-specific features.
///
/// Import this module where Redis-related operations are required.
///
mod in_redis;

/// The `mod interface` statement declares a module named `interface`.
///
/// A trait that defines the behavior of a session store backend.
/// This trait is intended to manage sessions by providing methods for retrieving,
/// saving, deleting, and cleaning up session data.
///
/// Implementors of the `SessionStore` trait must provide thread-safe and
/// shareable implementations (i.e., satisfy `Send` and `Sync`).
mod interface;

/// The v2 persistence contract for rolling simulations.
///
/// Deliberately separate from [`interface`]: the two store different documents
/// under different key spaces, and keeping the traits apart is what makes the
/// isolation structural rather than conventional.
mod v2_interface;

/// In-memory implementation of the v2 simulation store.
mod v2_memory;

/// Redis implementation of the v2 simulation store.
mod v2_redis;

pub use in_memory::InMemorySessionStore;
pub use in_redis::InRedisSessionStore;
pub use interface::SessionStore;
pub use v2_interface::SimulationStore;
pub use v2_memory::{DEFAULT_V2_RETENTION_SECS, InMemorySimulationStore};
pub use v2_redis::{DEFAULT_V2_KEY_PREFIX, InRedisSimulationStore};