Struct linefeed::memory::MemoryTerminal

pub struct MemoryTerminal { /* fields omitted */ }

Implements an in-memory Terminal interface

The contents of a MemoryTerminal are shared. That is, cloning a MemoryTerminal value will share the contained terminal buffer.

Methods

impl MemoryTerminal

pub fn new() -> MemoryTerminal

Returns a new MemoryTerminal with the default buffer size.

pub fn with_size(size: Size) -> MemoryTerminal

Returns a new MemoryTerminal with the given buffer size.

Panics

If either of the lines or columns fields are 0.

pub fn clear_all(&self)

Clears the terminal buffer and places the cursor at (0, 0).

pub fn clear_to_end(&self)

Clears all characters beginning at the cursor and ending at buffer end.

pub fn clear_input(&self)

Clears the input buffer.

pub fn has_input(&self) -> bool

Returns whether any input remains to be read.

pub fn lines(&self) -> Lines

Returns an iterator over lines in the buffer.

Notes

The returned iterator immutably borrows the contents of the MemoryTerminal. Attempting to perform a mutating operation on the parent MemoryTerminal while the Lines iterator lives will cause a panic.

pub fn move_up(&self, n: usize)

Moves the cursor up n cells.

pub fn move_down(&self, n: usize)

Moves the cursor down n cells.

pub fn move_left(&self, n: usize)

Moves the cursor left n cells.

pub fn move_right(&self, n: usize)

Moves the cursor right n cells.

pub fn move_to_first_column(&self)

Moves the cursor to the first column of the current line.

pub fn push_input(&self, s: &str)

Pushes a character sequence to the back of the input queue.

pub fn read_input(&self, buf: &mut [u8]) -> usize

Reads some input from the input buffer.

pub fn resize(&self, new_size: Size)

Changes the size of the terminal buffer. The buffer will be truncated or filled with spaces, as necessary.

Panics

If either of the lines or columns fields are 0 or if the area exceeds usize maximum.

pub fn scroll_up(&self, n: usize)

Moves the contents of the buffer up n lines. The first n lines of text will be erased.

pub fn cursor(&self) -> (usize, usize)

Returns the (line, column) position of the cursor.

pub fn set_cursor_mode(&self, mode: CursorMode)

Sets the cursor mode.

pub fn cursor_mode(&self) -> CursorMode

Returns the cursor mode.

pub fn size(&self) -> Size

Returns the size of the terminal buffer.

pub fn write(&self, s: &str)

Writes some text into the buffer.

If the text extends beyond the length of the current line without a newline character ('\n'), the extraneous text will be dropped.

Trait Implementations

impl Clone for MemoryTerminal

fn clone(&self) -> MemoryTerminal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryTerminal

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for MemoryTerminal

fn default() -> MemoryTerminal

Returns the "default value" for a type.

impl Terminal for MemoryTerminal

type 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<MemoryTerminal> for MemoryReadGuard<'a>

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

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

fn prepare(
    &mut self,
    _block_signals: bool,
    _report_signals: SignalSet
) -> Result<()>

Prepares the terminal for line reading and editing operations.

unsafe fn prepare_with_lock(
    &mut self,
    _lock: &mut TerminalWriter<MemoryTerminal>,
    _block_signals: bool,
    _report_signals: SignalSet
) -> Result<()>

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

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

Restores the terminal state using the given state data.

unsafe fn restore_with_lock(
    &mut self,
    _lock: &mut TerminalWriter<MemoryTerminal>,
    _state: ()
) -> 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.

impl<'a> TerminalWriter<MemoryTerminal> for MemoryWriteGuard<'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.