Struct RolloutRecorder 

pub struct RolloutRecorder { /* private fields */ }

Writes canonical session rollout items to JSONL.

Rollouts are recorded as JSONL and can be inspected with tools such as:

$ jq -C . ~/.codex/sessions/rollout-2025-05-07T17-24-21-5973b6c0-94b8-487b-a530-2aeb6098ae0e.jsonl
$ fx ~/.codex/sessions/rollout-2025-05-07T17-24-21-5973b6c0-94b8-487b-a530-2aeb6098ae0e.jsonl

Implementations

impl RolloutRecorder

pub async fn list_threads( state_db_ctx: Option<StateDbHandle>, config: &impl RolloutConfigView, page_size: usize, cursor: Option<&Cursor>, sort_key: ThreadSortKey, sort_direction: SortDirection, allowed_sources: &[SessionSource], model_providers: Option<&[String]>, cwd_filters: Option<&[PathBuf]>, default_provider: &str, search_term: Option<&str>, ) -> Result<ThreadsPage>

List threads (rollout files) under the provided Codex home directory.

pub async fn list_threads_from_state_db( state_db_ctx: Option<StateDbHandle>, config: &impl RolloutConfigView, page_size: usize, cursor: Option<&Cursor>, sort_key: ThreadSortKey, sort_direction: SortDirection, allowed_sources: &[SessionSource], model_providers: Option<&[String]>, cwd_filters: Option<&[PathBuf]>, default_provider: &str, search_term: Option<&str>, ) -> Result<ThreadsPage>

pub async fn list_archived_threads( state_db_ctx: Option<StateDbHandle>, config: &impl RolloutConfigView, page_size: usize, cursor: Option<&Cursor>, sort_key: ThreadSortKey, sort_direction: SortDirection, allowed_sources: &[SessionSource], model_providers: Option<&[String]>, cwd_filters: Option<&[PathBuf]>, default_provider: &str, search_term: Option<&str>, ) -> Result<ThreadsPage>

List archived threads (rollout files) under the archived sessions directory.

pub async fn list_archived_threads_from_state_db( state_db_ctx: Option<StateDbHandle>, config: &impl RolloutConfigView, page_size: usize, cursor: Option<&Cursor>, sort_key: ThreadSortKey, sort_direction: SortDirection, allowed_sources: &[SessionSource], model_providers: Option<&[String]>, cwd_filters: Option<&[PathBuf]>, default_provider: &str, search_term: Option<&str>, ) -> Result<ThreadsPage>

pub async fn find_latest_thread_path( state_db_ctx: Option<StateDbHandle>, config: &impl RolloutConfigView, page_size: usize, cursor: Option<&Cursor>, sort_key: ThreadSortKey, allowed_sources: &[SessionSource], model_providers: Option<&[String]>, default_provider: &str, filter_cwd: Option<&Path>, ) -> Result<Option<PathBuf>>

Find the newest recorded thread path, optionally filtering to a matching cwd.

pub async fn new( config: &impl RolloutConfigView, params: RolloutRecorderParams, ) -> Result<Self>

Attempt to create a new RolloutRecorder.

For newly created sessions, this precomputes path/metadata and defers file creation/open until an explicit persist() call.

For resumed sessions, this immediately opens the existing rollout file.

pub fn rollout_path(&self) -> &Path

pub async fn record_canonical_items(&self, items: &[RolloutItem]) -> Result<()>

pub async fn persist(&self) -> Result<()>

Materialize the rollout file and persist all buffered items.

This is idempotent. If materialization fails, the recorder keeps all pending items in memory and a later persist() or flush() can retry opening and writing the rollout file.

pub async fn flush(&self) -> Result<()>

Flush all queued writes and wait until they are committed by the writer task.

If the first writer attempt fails, the writer drops and reopens the file handle before retrying. This returns an error only when that retry also fails or the writer task is gone.

pub async fn load_rollout_items( path: &Path, ) -> Result<(Vec<RolloutItem>, Option<ThreadId>, usize)>

pub async fn get_rollout_history(path: &Path) -> Result<InitialHistory>

pub async fn shutdown(&self) -> Result<()>

Drain pending items before stopping the writer task.

If draining fails, the writer stays alive so callers can continue retrying flush/shutdown.

Trait Implementations

impl Clone for RolloutRecorder

fn clone(&self) -> RolloutRecorder

Returns a duplicate of the value.

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

Performs copy-assignment from source.