Struct SessionWriter 

pub struct SessionWriter { /* private fields */ }

Append-only JSONL session writer.

Each session is a single .jsonl file. Records are appended one per line and never rewritten. The writer tracks a monotonic seq counter.

Implementations

impl SessionWriter

pub fn create( dir: &Path, session_id: &str, cwd: &str, title: &str, provider: &str, model: &str, websearch: &str, app_version: &str, config: Option<SessionConfigMeta>, ) -> Result<Self>

Create a new session file in dir with the given session id.

Writes the initial session_meta record as the first line.

pub fn next_sequence(&self) -> u64

Sequence number that will be assigned to the next appended record.

pub fn resume(path: &Path, session_id: &str) -> Result<Self>

Reopen an existing session file for append-only continuation.

The next sequence number is derived from the highest readable record sequence. Corrupt trailing lines are ignored consistently with SessionReader.

pub fn append(&mut self, record: SessionRecord) -> Result<()>

Append a record to the session file.

pub fn append_entry(&mut self, entry: &Entry, turn_id: &str) -> Result<()>

Append a transcript entry as a record, if it maps to one.

Streaming/live entries are skipped — only finalized entries are persisted for replay.

pub fn append_entry_with_artifact( &mut self, entry: &Entry, turn_id: &str, artifact: Option<ArtifactMetadata>, ) -> Result<()>

Append a finalized transcript entry with bounded artifact metadata.

pub fn append_tool_started( &mut self, turn_id: &str, call_id: &str, name: &str, args: &str, ) -> Result<()>

Append a tool_started record for a tool call that has begun.

This records the command start: tool name, call id, and arguments. The matching tool_finished (via Self::append_entry) records the output, status, and summary. For run_shell, an additional Self::append_shell_exec record captures exit code, elapsed time, and process kind.

pub fn append_context(&mut self, sources: &[ContextSource]) -> Result<()>

Append a context record with loaded AGENTS.md source metadata.

pub fn append_context_ledger( &mut self, turn_id: &str, ledger: &ContextLedger, ) -> Result<()>

Append a content-free context ledger snapshot for a prompt turn.

pub fn append_context_pin( &mut self, item: &ContextItem, reason: &str, ) -> Result<()>

Append a content-free user pin action.

pub fn append_context_drop( &mut self, item: &ContextItem, reason: &str, ) -> Result<()>

Append a content-free user drop action.

pub fn append_context_recovery( &mut self, item: &ContextItem, reason: &str, ) -> Result<()>

Append a content-free user recovery action.

pub fn append_compaction(&mut self, audit: &CompactionAudit) -> Result<()>

Append a compaction audit record without source payloads.

pub fn append_compaction_review( &mut self, recovery_handle: &str, review: CompactionReviewResult, ) -> Result<()>

Append the review decision for a previously pending compaction.

pub fn append_prompt_metadata( &mut self, turn_id: &str, metadata: &PromptMetadata, ) -> Result<()>

Append prompt assembly provenance for a user turn.

pub fn append_usage( &mut self, input_tokens: u64, output_tokens: u64, ) -> Result<()>

Append provider token usage for the session.

pub fn append_request_accounting( &mut self, turn_id: &str, accounting: &ProviderRequestAccounting, ) -> Result<()>

Append accounting for one successful provider request.

pub fn append_file_write( &mut self, turn_id: &str, result: &WriteResult, status: ToolStatus, ) -> Result<()>

Append a file-write audit record.

Records the operation type, path, before/after hashes and byte counts, and status. File content is never stored — only hashes and byte counts, so secrets and large files are not persisted.

pub fn append_mcp_config_changed( &mut self, turn_id: &str, previous_files: Vec<SessionConfigFile>, current_files: Vec<SessionConfigFile>, diagnostics: Vec<String>, ) -> Result<()>

Append an audit record when MCP config file hashes change mid-session.

pub fn append_shell_exec( &mut self, turn_id: &str, result: &ProcessResult, ) -> Result<()>

Append a shell-execution audit record.

Records the command argv, working directory, registry id, lifecycle status, exit code, elapsed time, and process kind. stdout/stderr are not stored here — they are captured in redacted and capped output records.

pub fn append_skill_activation( &mut self, activation: &SkillActivation, ) -> Result<()>

Append a skill activation metadata record.

pub fn append_queued(&mut self, kind: &str, text: &str) -> Result<()>

Append a queued input audit record.

pub fn append_acp_permission_request( &mut self, turn_id: &str, request: &PendingPermission, ) -> Result<()>

Append ACP permission request metadata.

pub fn append_acp_session( &mut self, metadata: &AcpSessionMetadata, ) -> Result<()>

Append ACP session metadata.

pub fn append_acp_permission_outcome( &mut self, turn_id: &str, tool_call_id: &str, outcome: &str, ) -> Result<()>

Append ACP permission outcome metadata.

pub fn path(&self) -> &Path

The session file path.

pub fn session_id(&self) -> &str

The session id.

Trait Implementations

impl Debug for SessionWriter

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

Formats the value using the given formatter.

impl Drop for SessionWriter

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.