Struct Terminal 

pub struct Terminal { /* private fields */ }

A handle to the terminal with RAII-based mode management.

Automatically restores terminal settings when dropped. Implements Write for direct output.

Examples

use extui::{Terminal, TerminalFlags};

let mut term = Terminal::open(
    TerminalFlags::RAW_MODE | TerminalFlags::ALT_SCREEN
)?;

Implementations

impl Terminal

pub fn is_raw(&self) -> bool

Returns true if the terminal is in raw mode.

pub fn with_bypass<T>(&mut self, func: impl FnMut() -> T) -> Result<T>

Temporarily restores original terminal settings while executing a function.

Useful for spawning subprocesses or showing prompts.

pub fn new(fd: RawFd, flags: TerminalFlags) -> Result<Terminal>

Creates a terminal handle from a raw file descriptor.

Errors

Returns an error if the file descriptor is not a terminal.

pub fn open(flags: TerminalFlags) -> Result<Terminal>

Opens the terminal using stdout.

Errors

Returns an error if stdout is not a terminal.

pub fn size(&self) -> Result<(u16, u16)>

Returns the terminal size as (columns, rows).

Trait Implementations

impl Drop for Terminal

fn drop(&mut self)

Executes the destructor for this type.

impl Write for Terminal

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.