Struct termit::Screen

pub struct Screen {
    pub wipe: bool,
    pub true_color: bool,
    /* private fields */
}

Terminal screen buffer

It helps prevent unnecessary trafic to the terminal:

• collect all the painting in one cycle, then print the result
• print only the diff between last and new cycle

You probably won’t use it directly and instead use the crate::Painter. If you do, however, it should be fairly straightforward.

Fields

wipe: bool

true_color: bool

Implementations

impl Screen

pub fn new(size: Point) -> Self

New screen buffer of the given size

pub fn clear(&mut self)

Clear the buffer

pub fn resize(&mut self, size: Point)

pub fn size(&self) -> Point

pub fn set_last_write(&mut self, pos: Point)

Set the position of the last write

pub fn last_write(&self) -> Option<Point>

Get the position of the last write

pub fn get(&self, point: Point) -> Option<(&ScreenStyle, &str)>

Get a symbol at given coordinates

If the coordinates are out of bounds or if the symbol is not set you get None

pub fn get_idx(&self, idx: usize) -> Option<(&ScreenStyle, &str)>

Get a symbol at given order index

If the coordinates are out of bounds or if the symbol is not set you get None

pub fn set( &mut self, point: Point, style: impl Into<ScreenStyle>, symbol: impl AsRef<str> )

Set a symbol at given coordinates

If the coordinates are out of bounds the symbol is ignored

pub fn set_idx( &mut self, idx: usize, style: impl Into<ScreenStyle>, symbol: impl AsRef<str> )

Set a symbol at given order index

If the coordinates are out of bounds the symbol is ignored

pub fn symbols<'a>( &'a self ) -> impl Iterator<Item = (Point, &'a ScreenStyle, &'a str)> + 'a

Dump all the currently set screen symbols

pub fn diffs<'a>( &'a mut self, scope: Option<Window>, refresh: bool ) -> impl Iterator<Item = (Point, &'a ScreenStyle, &'a str)>

Trait Implementations

impl Debug for Screen

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

Formats the value using the given formatter.

impl Default for Screen

fn default() -> Screen

Returns the “default value” for a type.