Struct ToolOutputSpooler 

pub struct ToolOutputSpooler { /* private fields */ }

Tool Output Spooler for writing large outputs to files

Implementations

impl ToolOutputSpooler

pub fn new(workspace_root: &Path) -> Self

Create a new spooler for the given workspace

pub fn with_config(workspace_root: &Path, config: SpoolerConfig) -> Self

Create a new spooler with custom configuration

pub fn should_spool(&self, value: &Value) -> bool

Check if a value should be spooled based on size

pub async fn spool_output( &self, tool_name: &str, value: &Value, is_mcp: bool, ) -> Result<SpoolResult>

Spool a tool output to a file and return a reference

pub async fn process_output( &self, tool_name: &str, value: Value, is_mcp: bool, ) -> Result<Value>

Process a tool output, spooling if necessary.

Returns the original value if below threshold, or a condensed head+tail payload with a spool_path reference if spooled. Triggers periodic age-based cleanup of old spooled files.

pub async fn process_output_with_force( &self, tool_name: &str, value: Value, is_mcp: bool, force_spool: bool, ) -> Result<Value>

Process a tool output, optionally forcing spool behavior.

force_spool=true bypasses the size threshold but still respects explicit no_spool=true in the payload.

pub async fn pin_spool_files(&self, paths: &[PathBuf])

Pin spool files referenced by a blocked-turn handoff so age/eviction cleanup cannot delete them before the user resumes. Pins are bounded: callers must release them when the blocker resolves.

pub async fn unpin_spool_files(&self, paths: &[PathBuf])

Release pins for spool files that are no longer needed (e.g. blocker resolved). Missing entries are ignored.

pub fn spool_paths_from_value(value: &Value) -> Option<String>

Extract workspace-relative spool paths from model-facing values so a blocked-turn handoff can pin exactly the files the next turn needs.

pub async fn cleanup_old_files(&self) -> Result<usize>

Clean up old spooled files and sync the in-memory tracking list. Pinned blocked-turn outputs are never deleted here.

Also enforces SpoolerConfig::max_files against the on-disk directory (not just this instance’s tracking vec) so leftovers from prior sessions cannot accumulate past the budget.

pub async fn cleanup_expired_files(&self) -> Result<usize>

Age-based cleanup only, for startup paths.

The count budget relies on Self::pinned_files, which is per-process: a second session starting in the same workspace cannot see a concurrent session’s pinned or active spools, so enforcing the count budget at startup can delete young files the other session still reads from its conversation history. Age-expired files are safe to drop anywhere: no live session produced them within max_age_secs. The count budget stays on the in-session periodic path (Self::cleanup_old_files).

pub fn output_dir(&self) -> &Path

Get the output directory path

pub fn config(&self) -> &SpoolerConfig

Get current configuration

pub fn set_config(&mut self, config: SpoolerConfig)

Update configuration

pub async fn list_spooled_files(&self) -> Vec<PathBuf>

List currently spooled files