Struct linefeed::terminal::DefaultTerminal

pub struct DefaultTerminal(_);

Default Terminal interface

Methods

impl DefaultTerminal

pub fn new() -> Result<DefaultTerminal>

Opens access to the terminal device associated with standard output.

pub fn stderr() -> Result<DefaultTerminal>

Opens access to the terminal device associated with standard error.

Trait Implementations

impl Terminal for DefaultTerminal

type PrepareState = PrepareState

Returned by prepare; passed to restore to restore state.

fn name(&self) -> &str

Returns the name of the terminal.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn lock_read<'a>(&'a self) -> Box<TerminalReader<Self> + 'a>

Acquires a lock on terminal read operations and returns a value holding that lock and granting access to such operations.

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn lock_write<'a>(&'a self) -> Box<TerminalWriter<Self> + 'a>

Acquires a lock on terminal write operations and returns a value holding that lock and granting access to such operations.

impl<'a> TerminalReader<DefaultTerminal> for TerminalReadGuard<'a>

fn prepare(
    &mut self,
    block_signals: bool,
    report_signals: SignalSet
) -> Result<PrepareState>

Prepares the terminal for line reading and editing operations.

unsafe fn prepare_with_lock(
    &mut self,
    lock: &mut TerminalWriter<DefaultTerminal>,
    block_signals: bool,
    report_signals: SignalSet
) -> Result<PrepareState>

Like prepare, but called when the write lock is already held.

fn restore(&mut self, state: PrepareState) -> Result<()>

Restores the terminal state using the given state data.

unsafe fn restore_with_lock(
    &mut self,
    lock: &mut TerminalWriter<DefaultTerminal>,
    state: PrepareState
) -> Result<()>

Like restore, but called when the write lock is already held.

fn read(&mut self, buf: &mut Vec<u8>) -> Result<RawRead>

Reads some input from the terminal and appends it to the given buffer.

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

Waits timeout for user input. If timeout is None, waits indefinitely.

impl<'a> TerminalWriter<DefaultTerminal> for TerminalWriteGuard<'a>

fn size(&self) -> Result<Size>

Returns the size of the terminal window

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

Presents a clear terminal screen, with cursor at first row, first column.

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

Clears characters on the line occupied by the cursor, beginning with the cursor and ending at the end of the line. Also clears all characters on all lines after the cursor.

fn move_up(&mut self, n: usize) -> Result<()>

Moves the cursor up n cells; n may be zero.

fn move_down(&mut self, n: usize) -> Result<()>

Moves the cursor down n cells; n may be zero.

fn move_left(&mut self, n: usize) -> Result<()>

Moves the cursor left n cells; n may be zero.

fn move_right(&mut self, n: usize) -> Result<()>

Moves the cursor right n cells; n may be zero.

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

Moves the cursor to the first column of the current line

fn set_cursor_mode(&mut self, mode: CursorMode) -> Result<()>

Set the current cursor mode

fn write(&mut self, s: &str) -> Result<()>

Writes output to the terminal.

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

Flushes any currently buffered output data.