Struct andiskaz::terminal::Terminal

pub struct Terminal { /* private fields */ }

An application’s handle to the terminal.

Implementations

impl Terminal

pub async fn run<F, A, T>(start: F) -> Result<T, Error>where F: FnOnce(Terminal) -> A + Send + 'static, A: Future<Output = T> + Send + 'static, T: Send + 'static,

Runs the terminal application with the default settings, i.e. minumum screen is 80x25, 20ms for frame rendering interval, and 20ms for event polling from the OS.

Gives the application a handle to the terminal. When the given start function finishes, the application’s execution stops as well.

After that start’s future returns, terminal services such as screen handle and events handle are not guaranteed to be available. One would prefer spawning tasks that use the terminal handle by joining them, and not detaching.

Returns an AlreadyRunning error if there is already an instance of terminal services executing. In other words, one should not call this function again if another call did not finish yet, otherwise it will panic.

Beware! If the given start future returns a Result, then run will return a double Result!!

pub async fn lock_now<'terminal>( &'terminal mut self ) -> Result<TerminalGuard<'terminal>, ServicesOff>

Locks the terminal immediately (except it has to wait for the lock to be available). A locked terminal handle is returned, on which an application can write to the screen or get the most recent event.

Screen is locked, event channel is locked.

pub async fn listen<'terminal>( &'terminal mut self ) -> Result<TerminalGuard<'terminal>, ServicesOff>

Listens for an event and only finishes when an event arrives. A locked terminal handle is returned, on which an application can write to the screen or get the most recent event, which will be present.

Screen is locked, event channel is locked.

pub fn clear_event(&mut self)

Clears the event channel. After this call, the current event is marked as read and it will no longer be available.

pub async fn wait_user<'terminal>( &'terminal mut self, delay: Duration ) -> Result<TerminalGuard<'terminal>, ServicesOff>

Waits for user input before continuing, but waits for some given time (delay). Clears any previous event after waiting and listening to a new event.

Trait Implementations

impl Clone for Terminal

fn clone(&self) -> Terminal

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Terminal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.