Struct Input

pub struct Input { /* private fields */ }

Manages handling terminal input from stdin.

The primary interface provided is read_key. You can additionally configure the types of keypresses you are interested in through the parse_* methods. This configuration can be changed between any two calls to read_key.

Implementations

impl Input

pub fn new() -> Result<Self>

Creates a new Input instance containing a RawGuard instance.

Errors

• Error::SetTerminalMode: failed to put the terminal into raw mode

pub fn new_without_raw() -> Self

Creates a new Input instance without creating a RawGuard instance.

pub fn take_raw_guard(&mut self) -> Option<RawGuard>

Removes the RawGuard instance stored in this Input instance and returns it. This can be useful if you need to manage the lifetime of the RawGuard instance separately.

pub fn parse_utf8(&mut self, parse: bool)

Sets whether read_key should try to produce String or Char keys when possible, rather than Bytes or Byte keys. Note that Bytes or Byte keys may still be produced if the input fails to be parsed as UTF-8. Defaults to true.

pub fn parse_ctrl(&mut self, parse: bool)

Sets whether read_key should produce Ctrl keys when possible, rather than Bytes or Byte keys. Defaults to true.

pub fn parse_meta(&mut self, parse: bool)

Sets whether read_key should produce Meta keys when possible, rather than producing the Escape key separately. Defaults to true.

pub fn parse_special_keys(&mut self, parse: bool)

Sets whether read_key should produce keys other than String, Char, Bytes, Byte, Ctrl, or Meta. Defaults to true.

pub fn parse_single(&mut self, parse: bool)

Sets whether read_key should produce individual Char or Byte keys, rather than combining them into String or Bytes keys when possible. When this is true, String and Bytes will never be returned, and when this is false, Char and Byte will never be returned. Defaults to true.

pub fn read_key(&mut self) -> Result<Option<Key>>

Reads a keypress from the terminal on stdin. Returns Ok(None) on EOF.

Errors

• Error::ReadStdin: failed to read data from stdin