Struct OutputStreams 

pub struct OutputStreams { /* private fields */ }

Manages stdout and stderr streams

Supports optional pager integration for large output. When created with with_pager(), stdout writes are buffered and may be piped through a pager (like less) if output exceeds terminal height.

Implementations

impl OutputStreams

pub fn new() -> Self

Create streams using actual stdout/stderr (no paging)

pub fn with_pager(config: PagerConfig) -> Self

Create streams with pager support

When pager is enabled, stdout output is buffered and may be piped through a pager (like less) if output exceeds terminal height.

Call finish() at the end to properly handle pager lifecycle.

pub fn write_result(&mut self, content: &str) -> Result<()>

Write results to stdout (data stream)

Errors

Returns an error if writing to stdout fails.

pub fn write_diagnostic(&mut self, content: &str) -> Result<()>

Write diagnostic to stderr (diagnostic stream)

Errors

Returns an error if writing to stderr fails.

pub fn flush_stderr(&mut self) -> Result<()>

Flush stderr (for –explain to avoid interleaving)

Errors

Returns an error if flushing stderr fails.

pub fn finish(self) -> Result<PagerExitStatus>

Finalize output, flushing buffer and waiting for pager if applicable

Returns the pager exit status. For non-pager streams, returns Success. Call this at the end of command execution to properly handle pager lifecycle.

Errors

Returns an error if flushing or waiting for pager fails.

pub fn finish_checked(self) -> Result<()>

Finalize output and check for pager exit status

This is a convenience method that combines finish() with pager exit code checking. If the pager exited with a non-zero code, returns a CliError::PagerExit.

Errors

Returns an error if:

• Flushing or waiting for pager fails (IO error)
• Pager exited with non-zero code (CliError::PagerExit)

Trait Implementations

impl Default for OutputStreams

fn default() -> Self

Returns the “default value” for a type.