Struct OrderBookBuilder 

pub struct OrderBookBuilder { /* private fields */ }

A builder for constructing an OrderBook with custom options.

Use this struct to configure optional features such as journaling before creating an OrderBook instance.

Implementations

impl OrderBookBuilder

pub fn new(symbol: impl Into<String>) -> Self

Creates a new builder instance for the given symbol.

Parameters

• symbol: The market symbol (e.g., "BTCUSD")

pub fn with_options(self, options: OrderBookOptions) -> Self

Sets all options in bulk via an OrderBookOptions struct.

This method can be used for advanced configuration.

pub fn with_snapshot(self, snapshot: Snapshot) -> Self

Attaches a snapshot to this builder, so that the constructed OrderBook will be restored to the state captured in the snapshot rather than starting empty.

Parameters

• snapshot: A previously captured Snapshot representing the full state of an order book at a given point in time.

Returns

The builder itself, allowing method chaining.

pub fn with_replay_logs(self, logs: Vec<JournalLog>) -> Self

Sets a sequence of journal logs to be replayed after snapshot restoration.

This allows the order book to reconstruct its state by first restoring a snapshot (if provided) and then applying all operations contained in the logs.

Parameters

• logs: A vector of JournalLog entries to replay. Logs should ideally be in chronological order (op_id ascending), but replay_logs will sort them internally.

Returns

Returns self to allow chaining with other builder methods.

pub fn with_journaling(self, enabled: bool) -> Self

Enables or disables journaling.

Parameters

• enabled: true to enable journaling

pub fn build(self) -> OrderBook

Builds and returns a fully configured OrderBook instance.

Returns

An OrderBook with the configured options.