Struct SessionLogger 

pub struct SessionLogger { /* private fields */ }

Session logger that records terminal output to files.

The logger captures PTY output with timestamps and can export to multiple formats. It uses buffered writes for performance.

See the module-level documentation for information about sensitive data filtering.

Implementations

impl SessionLogger

pub fn new( format: SessionLogFormat, log_dir: &Path, dimensions: (usize, usize), title: Option<String>, ) -> Result<Self>

Create a new session logger.

Arguments

• format - The output format to use
• log_dir - Directory where log files are stored
• dimensions - Terminal dimensions (cols, rows)
• title - Optional session title

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

Start logging.

pub fn stop(&mut self) -> Result<PathBuf>

Stop logging and finalize the log file.

pub fn set_redact_passwords(&mut self, enabled: bool)

Enable or disable password prompt detection and input redaction.

When enabled, the logger monitors terminal output for common password prompt patterns and suppresses input recording during password entry. Enabled by default.

pub fn redact_passwords(&self) -> bool

Check whether password redaction is enabled.

pub fn set_echo_suppressed(&mut self, suppressed: bool)

Externally signal that echo is suppressed (e.g., PTY echo off).

When set to true, all input recording is suppressed regardless of prompt detection. This is useful when the caller has access to the terminal’s echo mode state.

Call with false when echo is re-enabled.

pub fn echo_suppressed(&self) -> bool

Check whether echo is externally marked as suppressed.

pub fn record_output(&mut self, data: &[u8])

Record output data from the terminal.

pub fn record_input(&mut self, data: &[u8])

Record input data (keyboard input).

When password redaction is active (either via prompt detection or explicit echo suppression), input data is replaced with a redaction marker. A newline or carriage return in the input data signals the end of a password entry, clearing the prompt-detected suppression.

pub fn record_resize(&mut self, cols: usize, rows: usize)

Record a terminal resize event.

pub fn is_active(&self) -> bool

Check if logging is active.

A write failure clears active, so this reflects writer health and not just the user’s last toggle: a transcript that stopped growing mid-session must not keep reporting itself as being recorded.

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

The write failure that stopped logging, if any.

pub fn output_path(&self) -> &PathBuf

Get the output path.

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

Flush buffered data to disk.

Trait Implementations

impl Drop for SessionLogger

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.