Struct ScreenContext 

pub struct ScreenContext<'a, W: Write = Stdout> { /* private fields */ }

Context guard for alternate screen mode.

This struct provides RAII semantics for alternate screen operations. When dropped, it automatically leaves alternate screen mode and restores the cursor if it was hidden.

Use Console::screen() to create a ScreenContext.

Implementations

impl<'a, W: Write> ScreenContext<'a, W>

pub fn update<R: Renderable + 'static>(&mut self, renderable: R) -> Result<()>

Update the screen with new content.

This renders the given renderable to fill the terminal dimensions.

Arguments

• renderable - The content to display on the screen.

Example

let mut screen = console.screen(true, None)?;
screen.update(Text::plain("Hello, World!"))?;

pub fn update_with_style<R: Renderable + 'static>( &mut self, renderable: R, style: Option<Style>, ) -> Result<()>

Update the screen with new content and optional style override.

Arguments

• renderable - The content to display on the screen.
• style - Optional style override for the screen background.

pub fn update_many<I, R>(&mut self, renderables: I) -> Result<()>

where I: IntoIterator<Item = R>, R: Renderable + 'static,

Update the screen with multiple renderables.

The renderables are grouped together and rendered as a single unit.

Arguments

• renderables - Iterator of renderables to display.

pub fn update_many_with_style<I, R>( &mut self, renderables: I, style: Option<Style>, ) -> Result<()>

where I: IntoIterator<Item = R>, R: Renderable + 'static,

Update the screen with multiple renderables and optional style.

Arguments

• renderables - Iterator of renderables to display.
• style - Optional style override for the screen background.

pub fn set_style(&mut self, style: Option<Style>)

Set the default style for the screen.

This style will be used for all subsequent update() calls unless overridden with update_with_style().

pub fn style(&self) -> Option<Style>

Get the current default style.

pub fn is_active(&self) -> bool

Check if alternate screen mode is active.

pub fn console(&self) -> &Console<W>

Get a reference to the underlying console.

pub fn console_mut(&mut self) -> &mut Console<W>

Get a mutable reference to the underlying console.

Trait Implementations

impl<W: Write> Drop for ScreenContext<'_, W>

fn drop(&mut self)

Executes the destructor for this type.