Struct term::WinConsole

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

A Terminal implementation which uses the Win32 Console API.

Implementations

impl<T: Write + Send> 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.

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

Sets the foreground color to the given color.

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

Sets the background color to the given color.

pub 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.

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

Returns whether the given terminal attribute is supported.

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

Resets all terminal attributes and colors to their defaults.

pub fn supports_reset(&self) -> bool

Returns true if reset is supported.

pub fn supports_color(&self) -> bool

Returns true if color is fully supported.

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

Moves the cursor up one line.

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

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

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

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

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

Gets an immutable reference to the stream inside

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

Gets a mutable reference to the stream inside

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

Returns the contained stream, destroying the Terminal

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

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

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

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

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

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

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

pub fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

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

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

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