Struct tuikit::screen::Screen

pub struct Screen { /* fields omitted */ }

A Screen is a table of cells to draw on. It's a buffer holding the contents

Implementations

impl Screen

pub fn new(width: usize, height: usize) -> Self

create an empty screen with size: (width, height)

pub fn width(&self) -> usize

get the width of the screen

pub fn height(&self) -> usize

get the height of the screen

pub fn resize(&mut self, width: usize, height: usize)

to resize the screen to (width, height)

pub fn present(&mut self) -> Vec<Command>

sync internal buffer with the terminal

pub fn iter_cell(&self) -> CellIterator<'_>

use tuikit::cell::Cell;
use tuikit::canvas::Canvas;
use tuikit::screen::Screen;


let mut screen = Screen::new(1, 1);
screen.put_cell(0, 0, Cell{ ch: 'a', ..Cell::default()});
let mut iter = screen.iter_cell();
assert_eq!(Some((0, 0, &Cell{ ch: 'a', ..Cell::default()})), iter.next());
assert_eq!(None, iter.next());

Trait Implementations

impl Canvas for Screen

fn size(&self) -> Result<(usize, usize)>

Get the canvas size (width, height)

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

clear the screen buffer

fn put_cell(&mut self, row: usize, col: usize, cell: Cell) -> Result<usize>

change a cell of position (row, col) to cell

fn set_cursor(&mut self, row: usize, col: usize) -> Result<()>

move cursor position (row, col) and show cursor

fn show_cursor(&mut self, show: bool) -> Result<()>

show/hide cursor, set show to false to hide the cursor

fn put_char_with_attr(
    &mut self,
    row: usize,
    col: usize,
    ch: char,
    attr: Attr
) -> Result<usize>

just like put_cell, except it accept (char & attr) return the width of the character/cell

fn print_with_attr(
    &mut self,
    row: usize,
    col: usize,
    content: &str,
    attr: Attr
) -> Result<usize>

print content starting with position (row, col) with attr

fn print(&mut self, row: usize, col: usize, content: &str) -> Result<usize>

print content starting with position (row, col) with default attribute

impl Debug for Screen

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

Formats the value using the given formatter.