Struct sunrise_libuser::terminal::Terminal

pub struct Terminal {
    buffer: ArrayVec<[u8; 256]>,
    pipe: IPipeProxy,
}

A struct for logging text to the window.

Writes to the Terminal are buffered until either a \n is sent, or more than 256 bytes are written. To immediately draw a write, use [fn draw].

Reads are similarly buffered until a \n is received by vi.

Fields

buffer: ArrayVec<[u8; 256]>

Internal write buffer.

pipe: IPipeProxy

The vi pipe backing this terminal.

Implementations

impl Terminal

pub fn new(size: WindowSize) -> Result<Terminal, Error>

Creates a new Window of the requested size for terminal usage.

pub fn draw(&mut self) -> Result<(), Error>

Flush the write buffer and draw the text.

pub fn clone_pipe(&self) -> Result<IPipeProxy, Error>

Clone this terminal's pipe.

pub fn read(&mut self, data: &mut [u8]) -> Result<u64, Error>

Read a line of text. Note that it might return without reading an entire line if the buffer is not big enough. The user should check if a \n is present in data.

Trait Implementations

impl Debug for Terminal

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

Formats the value using the given formatter.

impl Write for Terminal

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

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a [char] into this writer, returning whether the write succeeded.

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

Glue for usage of the [write!] macro with implementors of this trait.