Struct term::terminfo::TerminfoTerminal

[+] Show declaration

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

[−] Expand description

A Terminal that knows how many colors it supports, with a reference to its parsed Terminfo database record.

Implementations

impl<T: Write> TerminfoTerminal<T>[−]

pub fn new_with_terminfo(out: T, terminfo: TermInfo) -> TerminfoTerminal<T>[−]

Create a new TerminfoTerminal with the given TermInfo and Write.

pub fn new(out: T) -> Option<TerminfoTerminal<T>>[−]

Create a new TerminfoTerminal for the current environment with the given Write.

Returns None when the terminfo cannot be found or parsed.

Trait Implementations

impl<T: Clone> Clone for TerminfoTerminal<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> TerminfoTerminal<T>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Debug> Debug for TerminfoTerminal<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl<T: Write> Terminal for TerminfoTerminal<T>[+]

[+] Show hidden undocumented items

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(&self) -> &T[−]

Gets an immutable reference to the stream inside

fn get_mut(&mut self) -> &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 TerminfoTerminal<T>[+]

[+] Show hidden undocumented items

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.

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.