Struct crossterm_screen::AlternateScreen

pub struct AlternateScreen { /* fields omitted */ }

An alternate screen.

With this type, you will be able to switch to the alternate screen and then back to the main screen.

Be aware that you'll be switched back to the main screen when you drop the AlternateScreen value.

It's recommended to use the command API. See the EnterAlternateScreen and LeaveAlternateScreen commands documentation for more info.

Examples

Alternate screen with raw mode enabled:

use crossterm_screen::AlternateScreen;
use crossterm_utils::Result;

fn main() -> Result<()> {
    let _alternate = AlternateScreen::to_alternate(true)?;

    // Do something on the alternate screen in the raw mode

    Ok(())
} // `_alternate` dropped here <- raw mode disabled & back to main screen

Methods

impl AlternateScreen

pub fn to_alternate(raw_mode: bool) -> Result<AlternateScreen>

Switches to the alternate screen.

Arguments

• raw_mode - true enables the raw mode as well

Notes

You'll be automatically switched to the main screen if this function fails.

pub fn to_main(&self) -> Result<()>

Switches to the main screen.

Trait Implementations

impl Drop for AlternateScreen

fn drop(&mut self)

Executes the destructor for this type.