Struct crossterm::terminal::EnterAlternateScreen

pub struct EnterAlternateScreen;

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::{stdout, Write};
use crossterm::{execute, Result, terminal::{EnterAlternateScreen, LeaveAlternateScreen}};

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

    // Do anything on the alternate screen

    execute!(stdout(), LeaveAlternateScreen)
}

Trait Implementations

impl Clone for EnterAlternateScreen

fn clone(&self) -> EnterAlternateScreen

Returns a copy 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

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.

fn execute_winapi(&self) -> Result<()>

Execute this command.

fn is_ansi_code_supported(&self) -> bool

Returns whether the ANSI code representation of this command is supported by windows.

impl Debug for EnterAlternateScreen

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

Formats the value using the given formatter.

impl PartialEq<EnterAlternateScreen> for EnterAlternateScreen

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EnterAlternateScreen

impl Eq for EnterAlternateScreen

impl StructuralEq for EnterAlternateScreen

impl StructuralPartialEq for EnterAlternateScreen