Struct CrosstermBackend 

pub struct CrosstermBackend<W> { /* private fields */ }

The initial terminal backend, implemented with crossterm behind this module.

Implementations

impl<W> CrosstermBackend<W>

pub const fn new(writer: W) -> Self

pub const fn writer(&self) -> &W

pub fn writer_mut(&mut self) -> &mut W

pub fn into_inner(self) -> W

Trait Implementations

impl<W: Write> CommandWriter for CrosstermBackend<W>

fn write_command(&mut self, command: Command<'_>) -> Result<()>

Queues or writes one command.

impl<W> EventSource for CrosstermBackend<W>

fn read_event(&mut self) -> Result<Event>

Blocks until one supported terminal event is available.

fn poll_event(&mut self) -> Result<Option<Event>>

Returns one already-waiting event without blocking.

fn poll_event_timeout(&mut self, timeout: Duration) -> Result<Option<Event>>

Waits up to timeout for one event.

impl<W> KeyboardEnhancementQuery for CrosstermBackend<W>

fn supports_keyboard_enhancement(&mut self) -> Result<bool>

impl<W: Write + IsTerminal> RawModeControl for CrosstermBackend<W>

fn is_interactive(&self) -> bool

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

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

impl<W: Write> TerminalOutput for CrosstermBackend<W>

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

impl<W> TerminalQuery for CrosstermBackend<W>

fn terminal_size(&mut self) -> Result<TerminalSize>

Queries the current visible size in character cells.

fn cursor_position(&mut self) -> Result<Position>

Queries the current zero-based cursor position.

fn window_size(&mut self) -> Result<WindowSize>

Queries both cell and pixel dimensions when the platform exposes them.

fn raw_mode_enabled(&mut self) -> Result<bool>

Reports whether process terminal input is currently in raw mode.

fn terminal_capabilities(&mut self) -> Result<TerminalCapabilities>

Queries rendering capabilities confirmed by the terminal.

fn terminal_background(&mut self) -> Result<Option<TerminalBackground>>

Queries the terminal’s current background color.