Struct EnterAlternateScreen 

pub struct EnterAlternateScreen;

Available on crate feature term only.

A command that switches to alternate screen.

Notes

• Commands must be executed/queued for execution otherwise they do nothing.
• Use LeaveAlternateScreen command to leave the entered alternate screen.

Examples

use std::io::{self, Write};
use crossterm::{execute, terminal::{EnterAlternateScreen, LeaveAlternateScreen}};

fn main() -> io::Result<()> {
    execute!(io::stdout(), EnterAlternateScreen)?;

    // Do anything on the alternate screen

    execute!(io::stdout(), LeaveAlternateScreen)
}

Trait Implementations

impl Clone for EnterAlternateScreen

fn clone(&self) -> EnterAlternateScreen

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Command for EnterAlternateScreen

fn write_ansi(&self, f: &mut impl Write) -> Result<(), Error>

Write an ANSI representation of this command to the given writer. An ANSI code can manipulate the terminal by writing it to the terminal buffer. However, only Windows 10 and UNIX systems support this.

impl Copy for EnterAlternateScreen

impl Debug for EnterAlternateScreen

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for EnterAlternateScreen

impl PartialEq for EnterAlternateScreen

fn eq(&self, other: &EnterAlternateScreen) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EnterAlternateScreen