Struct ScreenContext 

pub struct ScreenContext { /* private fields */ }

A context that enters the alternate screen buffer, provides an update method to display content, and automatically exits the alternate screen buffer on drop.

Created via Console::screen().

Example

let mut console = Console::new();
let ctx = console.screen();
ctx.update("Hello from alt-screen!");
std::thread::sleep(std::time::Duration::from_secs(2));
// ctx drops → exits alt screen

Implementations

impl ScreenContext

pub fn new() -> Self

Create a new ScreenContext (does not enter alt screen yet).

pub fn style(self, style: Style) -> Self

Builder: set the style for screen content.

pub fn enter(&mut self)

Enter the alternate screen buffer.

pub fn exit(&mut self)

Exit the alternate screen buffer, restoring the original screen.

pub fn update(&mut self, update: impl Into<ScreenUpdate>) -> Result<()>

Render the given content in the alternate screen.

pub fn is_active(&self) -> bool

Check whether the alternate screen is currently active.

Trait Implementations

impl Debug for ScreenContext

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

Formats the value using the given formatter.

impl Default for ScreenContext

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ScreenContext

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.