Struct TerminalWriter 

pub struct TerminalWriter<'a> { /* private fields */ }

Writable (implements Write) object for TerminalSurface

Implementations

impl<'a> TerminalWriter<'a>

pub fn new<S>(ctx: ViewContext, surf: &'a mut S) -> Self

where S: SurfaceMut<Item = Cell> + ?Sized,

pub fn cursor(&self) -> Position

Get current cursor position

pub fn set_cursor(&mut self, pos: Position) -> &mut Self

Move cursor to specified position

pub fn size(&self) -> Size

Get size of the view backing this writer

Trait Implementations

impl CellWrite for TerminalWriter<'_>

fn face(&self) -> Face

Get current face

fn set_face(&mut self, face: Face) -> Face

Set current face, returns previous face

fn wraps(&self) -> bool

Get wraps flag

fn set_wraps(&mut self, wraps: bool) -> bool

Set wraps flag, returns previous value

fn put_cell(&mut self, cell: Cell) -> bool

Put cell

fn with_face(self, face: Face) -> Self

where Self: Sized,

Return self with updated face

fn with_wraps(self, wraps: bool) -> Self

where Self: Sized,

Return self with updated wraps flag

fn scope(&mut self, scope: impl FnOnce(&mut Self)) -> &mut Self

Create scope that reverts face and wraps flags on exit

fn with_cell(self, cell: Cell) -> Self

where Self: Sized,

fn put_char(&mut self, character: char) -> bool

Put character

fn with_char(self, character: char) -> Self

where Self: Sized,

fn put_glyph(&mut self, glyph: Glyph) -> bool

Put glyph

fn with_glyph(self, glyph: Glyph) -> Self

where Self: Sized,

fn put_image(&mut self, image: Image) -> bool

Put image

fn with_image(self, image: Image) -> Self

where Self: Sized,

fn put_fmt<T>(&mut self, value: &T, face: Option<Face>) -> &mut Self

where T: Display + ?Sized,

Put anything that is format-able (Note: that std::format_args is also std::fmt::Display)

fn with_fmt<T>(self, value: &T, face: Option<Face>) -> Self

where T: Display + ?Sized, Self: Sized,

fn put_text(&mut self, text: &Text) -> &mut Self

Put Text

fn with_text(self, text: &Text) -> Self

where Self: Sized,

fn utf8_writer(self) -> Utf8CellWriter<Self>

where Self: Sized,

Returns std::io::Write that can decode UTF8 characters

fn tty_writer(self) -> TTYCellWriter<Self>

where Self: Sized,

Returns std::io::Write that can decode TTY escape sequences

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

where Self: Sized,

Create a reference of self

impl Write for TerminalWriter<'_>

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

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

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

Flushes 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 is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

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.

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

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

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.