Struct crossterm_screen::RawScreen

pub struct RawScreen { /* fields omitted */ }

A raw screen.

Be aware that the raw mode is disabled when you drop the RawScreen value. Call the keep_raw_mode_on_drop method to disable this behavior (keep the raw mode enabled).

Examples

Basic usage:

use crossterm_screen::RawScreen;
use crossterm_utils::Result;

fn main() -> Result<()> {
    let _raw = RawScreen::into_raw_mode()?;
    // Do something in the raw mode
    Ok(())
} // `_raw` is dropped here <- raw mode is disabled

Do not disable the raw mode implicitly:

use crossterm_screen::RawScreen;
use crossterm_utils::Result;

fn main() -> Result<()> {
    let mut raw = RawScreen::into_raw_mode()?;
    raw.keep_raw_mode_on_drop();
    // Feel free to leave `raw` on it's own/drop it, the raw
    // mode won't be disabled

    // Do something in the raw mode

    // Disable raw mode explicitly
    RawScreen::disable_raw_mode()
}

Methods

impl RawScreen

pub fn into_raw_mode() -> Result<RawScreen>

Enables raw mode.

pub fn disable_raw_mode() -> Result<()>

Disables raw mode.

pub fn keep_raw_mode_on_drop(&mut self)

Keeps the raw mode enabled when self is dropped.

See the RawScreen documentation for more information.

Trait Implementations

impl Drop for RawScreen

fn drop(&mut self)

Executes the destructor for this type.