Struct AlternateScreenSession 

pub struct AlternateScreenSession { /* private fields */ }

Manages entering and exiting alternate screen with proper state preservation

This struct ensures that terminal state is properly saved before entering alternate screen and restored when exiting, even in the presence of errors.

Example

use vtcode_tui::core_tui::alternate_screen::AlternateScreenSession;

// Run a closure in alternate screen with automatic cleanup
let result = AlternateScreenSession::run(|| {
    // Your code that runs in alternate screen
    println!("Running in alternate screen!");
    Ok(())
})?;

Implementations

impl AlternateScreenSession

pub fn enter() -> Result<Self>

Enter alternate screen, saving current terminal state

This will:

1. Save the current terminal state
2. Enter alternate screen
3. Enable raw mode
4. Enable bracketed paste
5. Enable focus change events (if supported)
6. Push keyboard enhancement flags (if supported)

Errors

Returns an error if any terminal operation fails.

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

Exit alternate screen, restoring original terminal state

This will:

1. Pop keyboard enhancement flags (if they were pushed)
2. Disable focus change events (if they were enabled)
3. Disable bracketed paste (if it was enabled)
4. Disable raw mode (if it was enabled)
5. Leave alternate screen

Errors

Returns an error if any terminal operation fails. However, this method will attempt to restore as much state as possible even if some operations fail.

pub fn run<F, T>(f: F) -> Result<T>

where F: FnOnce() -> Result<T>,

Run a closure in alternate screen with automatic cleanup

This is a convenience method that handles entering and exiting alternate screen automatically, ensuring cleanup happens even if the closure panics.

Errors

Returns an error if entering/exiting alternate screen fails, or if the closure returns an error.

Trait Implementations

impl Drop for AlternateScreenSession

fn drop(&mut self)

Executes the destructor for this type.