Struct mortal::screen::ScreenReadGuard

pub struct ScreenReadGuard<'a>(_);

Holds an exclusive lock for read operations on a Screen

See Screen documentation for details on locking.

Methods

impl<'a> ScreenReadGuard<'a>

pub fn wait_event(&mut self, timeout: Option<Duration>) -> Result<bool>

Waits for an event from the terminal.

Returns Ok(false) if timeout elapses without an event occurring.

If timeout is None, this method will wait indefinitely.

Notes

Some low-level terminal events may not generate an Event value. Therefore, this method may return Ok(true), while a follow-up call to read_event may not immediately return an event.

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

Reads an event from the terminal.

If timeout elapses without an event occurring, this method will return Ok(None).

If timeout is None, this method will wait indefinitely.

Trait Implementations

impl<'a> TerminalExt for ScreenReadGuard<'a>

fn read_raw(
    &mut self,
    buf: &mut [u8],
    timeout: Option<Duration>
) -> Result<Option<Event>>

Reads raw data from the terminal.