Skip to main content

Checkpoint

Struct Checkpoint 

Source
pub struct Checkpoint {
    pub version: u32,
    pub symbol: String,
    pub threshold_decimal_bps: u32,
    pub incomplete_bar: Option<OpenDeviationBar>,
    pub thresholds: Option<(FixedPoint, FixedPoint)>,
    pub last_timestamp_us: i64,
    pub last_trade_id: Option<i64>,
    pub price_hash: u64,
    pub anomaly_summary: AnomalySummary,
    pub prevent_same_timestamp_close: bool,
    pub defer_open: bool,
}
Expand description

Checkpoint for cross-file open deviation bar continuation

Enables seamless processing across any file boundaries (Binance daily, Exness monthly). Captures minimal state needed to continue building an incomplete bar.

§Example

// Process first file
let bars_1 = processor.process_agg_trade_records(&file1_trades)?;
let checkpoint = processor.create_checkpoint("BTCUSDT");

// Serialize and save checkpoint
let json = serde_json::to_string(&checkpoint)?;
std::fs::write("checkpoint.json", json)?;

// ... later, load checkpoint and continue processing ...
let json = std::fs::read_to_string("checkpoint.json")?;
let checkpoint: Checkpoint = serde_json::from_str(&json)?;
let mut processor = OpenDeviationBarProcessor::from_checkpoint(checkpoint)?;
let bars_2 = processor.process_agg_trade_records(&file2_trades)?;

Fields§

§version: u32

Schema version for checkpoint format (Issue #85: Phase 2) v1: Original format (default for old checkpoints) v2: Field-reordered OpenDeviationBar (no behavioral changes, safe for deserialization)

§symbol: String

Symbol being processed (e.g., “BTCUSDT”, “EURUSD”)

§threshold_decimal_bps: u32

Threshold in decimal basis points (v3.0.0+: 0.1bps units) Example: 250 = 25bps = 0.25%

§incomplete_bar: Option<OpenDeviationBar>

Incomplete bar at file boundary (None = last bar completed cleanly) REUSES existing OpenDeviationBar type - no separate BarState needed!

§thresholds: Option<(FixedPoint, FixedPoint)>

Fixed thresholds for incomplete bar (computed from bar.open, IMMUTABLE) Stored as (upper_threshold, lower_threshold)

§last_timestamp_us: i64

Last processed timestamp in microseconds (universal, works for all sources)

§last_trade_id: Option<i64>

Last trade ID (Some for Binance, None for Exness) Binance: agg_trade_id is strictly sequential, never resets

§price_hash: u64

Price window hash (ahash of last 8 prices for position verification) Used to verify we’re resuming at the correct position in data stream

§anomaly_summary: AnomalySummary

Anomaly summary counts for debugging

§prevent_same_timestamp_close: bool

Prevent bars from closing on same timestamp as they opened (Issue #36)

When true (default): A bar cannot close until a trade arrives with a different timestamp than the bar’s open_time. This prevents flash crash scenarios from creating thousands of bars at identical timestamps.

When false: Legacy v8 behavior - bars can close immediately on breach.

§defer_open: bool

Deferred bar open flag (Issue #46)

When true: The last trade before checkpoint triggered a threshold breach. On resume, the next trade should open a new bar instead of continuing. This matches the batch path’s defer_open semantics.

Implementations§

Source§

impl Checkpoint

Source

pub fn new( symbol: String, threshold_decimal_bps: u32, incomplete_bar: Option<OpenDeviationBar>, thresholds: Option<(FixedPoint, FixedPoint)>, last_timestamp_us: i64, last_trade_id: Option<i64>, price_hash: u64, prevent_same_timestamp_close: bool, ) -> Checkpoint

Create a new checkpoint with the given parameters

Source

pub fn has_incomplete_bar(&self) -> bool

Check if there’s an incomplete bar that needs to continue

Source

pub fn library_version() -> &'static str

Get the library version that created this checkpoint

Trait Implementations§

Source§

impl Clone for Checkpoint

Source§

fn clone(&self) -> Checkpoint

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Checkpoint

Source§

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

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

impl<'de> Deserialize<'de> for Checkpoint

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Checkpoint, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Checkpoint

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,