Struct terminal_escapes::Device

pub struct Device<I: Read, O: Write> { /* fields omitted */ }

A device handling escapes sequences.

Methods

impl<I: Read, O: Write> Device<I, O>

Important traits for Device<I, O>

impl<I: Read, O: Write> Read for Device<I, O>impl<I: Read, O: Write> Write for Device<I, O>

pub fn new(input: I, output: O) -> Device<I, O>

Create a new device from an input and output.

pub fn cursor_position(&mut self) -> Result<(u32, u32)>

Requests the cursor position on the device.

The output format is (row, column).

pub fn reset(&mut self) -> Result<()>

Reset all terminal settings to default.

pub fn line_wrap(&mut self, enable: bool) -> Result<()>

Enable/disable line wrapping.

pub fn font_default(&mut self) -> Result<()>

Set default font.

pub fn font_alternate(&mut self) -> Result<()>

Set alternate font.

pub fn cursor_at(&mut self, row: u32, column: u32) -> Result<()>

Set the cursor position.

pub fn cursor_move(&mut self, drow: i32, dcolumn: i32) -> Result<()>

Move the cursor position by the given delta.

(0, 0) is at the top left of the screen.

pub fn cursor_save(&mut self) -> Result<()>

Save the cursor position.

pub fn cursor_restore(&mut self) -> Result<()>

Resotre the saved cursor position.

pub fn cursor_save_attributes(&mut self) -> Result<()>

Save the cursor position.

pub fn cursor_restore_attributes(&mut self) -> Result<()>

Resotre the saved cursor position.

pub fn scroll_enable(&mut self, region: Option<(u32, u32)>) -> Result<()>

Enable scrolling.

If None is passed then scrolling is enabled for the whole screen. If Some((start, end)) is passed then scrolling is enabled from row start to end.

pub fn scroll(&mut self, rows: i32) -> Result<()>

Scroll by the given number of rows. Positive rows means scrolling down, negative rows means scrolling up.

pub fn erase_end_of_line(&mut self) -> Result<()>

Erases from the current cursor position to the end of the current line.

pub fn erase_start_of_line(&mut self) -> Result<()>

Erases from the current cursor position to the start of the current line.

pub fn erase_line(&mut self) -> Result<()>

Erases the entire current line.

pub fn erase_down(&mut self) -> Result<()>

Erases the screen from the current line down to the bottom of the screen.

pub fn erase_up(&mut self) -> Result<()>

Erases the screen from the current line up to the top of the screen.

pub fn erase_screen(&mut self) -> Result<()>

Erases the screen with the background colour and moves the cursor to home.

pub fn set_attributes(&mut self, attributes: &[Attribute]) -> Result<()>

Sets display attributes.

Trait Implementations

impl<I: Read, O: Write> Read for Device<I, O>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<I: Read, O: Write> Write for Device<I, O>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.