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) -> CrosstermBackend<W>

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

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

pub fn into_inner(self) -> W

Trait Implementations

impl<W> CommandWriter for CrosstermBackend<W>

where W: Write,

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

Queues or writes one command.

impl<W> EventSource for CrosstermBackend<W>

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

Blocks until one supported terminal event is available.

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

Returns one already-waiting event without blocking.

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

Waits up to timeout for one event.

impl<W> KeyboardEnhancementQuery for CrosstermBackend<W>

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

impl<W> RawModeControl for CrosstermBackend<W>

where W: Write + IsTerminal,

fn is_interactive(&self) -> bool

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

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

impl<W> TerminalOutput for CrosstermBackend<W>

where W: Write,

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

impl<W> TerminalQuery for CrosstermBackend<W>

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

Queries the current visible size in character cells.

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

Queries the current zero-based cursor position.

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

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

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

Reports whether process terminal input is currently in raw mode.

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

Queries rendering capabilities confirmed by the terminal.

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

Queries the terminal’s current background color.