Struct tty_interface::Interface

pub struct Interface<'a> { /* private fields */ }

A TTY-based user-interface providing optimized update rendering.

Implementations

impl Interface<'_>

pub fn for_stdout<'a>() -> Result<Interface<'a>>

Create a new interface for stdout.

Examples

use tty_interface::Interface;

let interface = Interface::for_stdout().expect("terminal size should be available");

pub fn for_writer(writer: &mut dyn Write) -> Result<Interface<'_>>

Create a new interface for the specified writer.

Examples

use tty_interface::Interface;
use std::io::{Write, stdout};

let writer: &mut dyn Write = &mut stdout();
let interface = Interface::for_writer(writer).expect("terminal size should be available");

pub fn exit(self) -> Result<()>

When finished using this interface, uninitialize its terminal configuration.

pub fn set(&mut self, position: Position, text: &str)

Update the interface’s text at the specified position. Changes are staged until applied.

Examples

use tty_interface::{Interface, Position, pos};

let mut interface = Interface::for_stdout().expect("terminal size should be available");
interface.set(pos!(1, 1), "Hello, world!");

pub fn set_styled(&mut self, position: Position, text: &str, style: Style)

Update the interface’s text at the specified position. Changes are staged until applied.

Examples

use tty_interface::{Interface, Position, pos, Style};

let mut interface = Interface::for_stdout().expect("terminal size should be available");
interface.set_styled(pos!(1, 1), "Hello, world!", Style::default().set_bold(true));

pub fn apply(&mut self) -> Result<()>

Applies staged changes to the terminal.

Examples

use tty_interface::{Interface, Position, pos};

let mut interface = Interface::for_stdout().expect("terminal size should be available");
interface.set(pos!(1, 1), "Hello, world!");
interface.apply().expect("updates should be valid");