Struct BacktestSession 

pub struct BacktestSession { /* private fields */ }

Active backtest session over a WebSocket connection.

Dropping the session sends a best-effort close frame if a Tokio runtime is available. Call BacktestSession::close to request server-side cleanup.

Implementations

impl BacktestSession

pub fn session_id(&self) -> Option<&str>

Return the server-assigned session id, if known.

pub fn rpc_endpoint(&self) -> Option<&str>

Return the session-scoped RPC endpoint if provided.

pub fn rpc(&self) -> &RpcClient

Return the RPC client for this session’s endpoint.

Always available after BacktestClient::create_session completes.

pub fn is_ready_for_continue(&self) -> bool

Return whether the session is currently ready to accept Continue.

pub fn apply_response(&mut self, response: &BacktestResponse)

Update internal readiness state based on a response.

pub async fn send( &mut self, request: &BacktestRequest, timeout: Option<Duration>, ) -> BacktestClientResult<()>

Send a raw backtest request over the WebSocket.

pub async fn next_response( &mut self, timeout: Option<Duration>, ) -> BacktestClientResult<Option<BacktestResponse>>

Receive the next response, using the backlog first.

pub async fn next_event( &mut self, timeout: Option<Duration>, ) -> BacktestClientResult<Option<BacktestResponse>>

Receive the next response and update readiness state.

pub fn responses( self, timeout: Option<Duration>, ) -> impl Stream<Item = BacktestClientResult<BacktestResponse>>

Stream responses, updating readiness state as items arrive.

This consumes the session and yields responses until the connection ends.

pub async fn ensure_ready( &mut self, timeout: Option<Duration>, ) -> BacktestClientResult<ReadyOutcome>

Wait for the session to become ready or completed.

pub async fn wait_for_status( &mut self, desired: BacktestStatus, timeout: Option<Duration>, ) -> BacktestClientResult<()>

Wait for a specific status to be emitted.

pub async fn send_continue( &mut self, params: ContinueParams, timeout: Option<Duration>, ) -> BacktestClientResult<()>

Send a Continue request and reset readiness.

pub async fn advance_step<F>( &mut self, state: &mut AdvanceState, wait_for_slots: bool, timeout: Option<Duration>, on_event: &mut F, ) -> BacktestClientResult<()>

where F: FnMut(&BacktestResponse),

Read and apply a single response while advancing.

pub async fn continue_until_ready<F>( &mut self, cont: Continue, timeout: Option<Duration>, on_event: F, ) -> BacktestClientResult<ContinueResult>

where F: FnMut(&BacktestResponse),

Advance until the session becomes ready for another Continue.

pub async fn advance<F>( &mut self, cont: Continue, timeout: Option<Duration>, on_event: F, ) -> BacktestClientResult<ContinueResult>

where F: FnMut(&BacktestResponse),

Advance and wait for both readiness and slot notifications.

pub async fn modify_program( &self, program_id: &str, elf: &[u8], ) -> Result<BTreeMap<Address, AccountData>, ProgramModError>

Build a program-data account modification from raw ELF bytes.

Derives the ProgramData address from program_id, queries the session’s RPC endpoint for the current slot and rent-exempt minimum, then returns a modification map ready to pass to Continue::builder().modify_accounts(...).

The deploy slot is set to current_slot - 1 so the program appears deployed before the next executed slot.

pub async fn modify_accounts( &self, modifications: &AccountModifications, ) -> BacktestClientResult<usize>

Modify accounts on the session’s RPC endpoint via the custom modifyAccounts method.

Returns the number of accounts modified on success.

pub async fn subscribe_program_logs<F, Fut>( &self, program_id: &str, commitment: CommitmentConfig, on_notification: F, ) -> Result<LogSubscriptionHandle, SubscriptionError>

where F: Fn(Response<RpcLogsResponse>) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Subscribe to program log notifications using the session’s RPC endpoint.

Equivalent to calling subscribe_program_logs with the endpoint from rpc_endpoint, which is set after BacktestClient::create_session completes.

pub async fn subscribe_account_diffs<F, Fut>( &self, account: &str, on_notification: F, ) -> Result<AccountDiffSubscriptionHandle, SubscriptionError>

where F: Fn(AccountDiffNotification) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Subscribe to account diff notifications using the session’s RPC endpoint.

Equivalent to calling subscribe_account_diffs with the endpoint from rpc_endpoint, which is set after BacktestClient::create_session completes.

pub async fn close( &mut self, timeout: Option<Duration>, ) -> BacktestClientResult<()>

Request server cleanup and close the underlying WebSocket.

This is idempotent and will return Ok(()) if the connection is already closed.

pub async fn close_with_frame( &mut self, timeout: Option<Duration>, frame: Option<CloseFrame<'static>>, ) -> BacktestClientResult<()>

Close the session with a specific WebSocket close frame.

pub async fn close_with_reason( &mut self, timeout: Option<Duration>, code: CloseCode, reason: impl Into<String>, ) -> BacktestClientResult<()>

Close the session with a close code and reason.

Trait Implementations

impl Debug for BacktestSession

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

Formats the value using the given formatter.

impl Drop for BacktestSession

fn drop(&mut self)

Executes the destructor for this type.