Struct term::WinConsole

pub struct WinConsole<T> { /* fields omitted */ }

A Terminal implementation which uses the Win32 Console API.

Methods

impl<T: Write + Send> WinConsole<T>

Important traits for WinConsole<T>

impl<T: Write> Write for WinConsole<T>

pub fn new_with_consoleinfo(out: T, info: WinConsoleInfo) -> WinConsole<T>

Create a new WinConsole with the given WinConsoleInfo and out

pub fn new(out: T) -> Result<WinConsole<T>>

Returns Err whenever the terminal cannot be created for some reason.

Trait Implementations

impl<T: Write + Send> Terminal for WinConsole<T>

type Output = T

The terminal's output writer type.

fn fg(&mut self, color: Color) -> Result<()>

Sets the foreground color to the given color.

fn bg(&mut self, color: Color) -> Result<()>

Sets the background color to the given color.

fn attr(&mut self, attr: Attr) -> Result<()>

Sets the given terminal attribute, if supported. Returns Ok(()) if the attribute is supported and was sent to the terminal, or Err(e) if there was an error or the attribute wasn't supported.

fn supports_attr(&self, attr: Attr) -> bool

Returns whether the given terminal attribute is supported.

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

Resets all terminal attributes and colors to their defaults.

fn supports_reset(&self) -> bool

Returns true if reset is supported.

fn supports_color(&self) -> bool

Returns true if color is fully supported.

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

Moves the cursor up one line.

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

Deletes the text from the cursor location to the end of the line.

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

Moves the cursor to the left edge of the current line.

fn get_ref<'a>(&'a self) -> &'a T

Gets an immutable reference to the stream inside

fn get_mut<'a>(&'a mut self) -> &'a mut T

Gets a mutable reference to the stream inside

fn into_inner(self) -> T where
    Self: Sized, 

Returns the contained stream, destroying the Terminal

impl<T: Write> Write for WinConsole<T>

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.