Struct RenderBuffer 

pub struct RenderBuffer {
    pub cells: Vec<Cell>,
    pub width: usize,
    pub height: usize,
}

Fields

cells: Vec<Cell>

width: usize

height: usize

Implementations

impl RenderBuffer

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

Creates a new RenderBuffer with a default style

Arguments

• width: The desired width of the buffer measured in “cells”
• height: The desired height of the buffer measured in “cells”
• default_style: Some default style for formatting the empty cells

Returns

• A newly constructed RenderBuffer with a default style and no content

pub fn new_with_contents( width: usize, height: usize, style: &Style, contents: Vec<String>, ) -> Self

Creates a new RenderBuffer with text

Arguments

• width: The desired width of the buffer measured in “cells”
• height: The desired height of the buffer measured in “cells”
• style: Styling to apply to the cells based on the provided content
• contents: A vector of strings representing the buffer’s text

Returns

• A constructed RenderBuffer with styling and textual content

pub fn clear(&mut self)

Clears the buffer by replacing all characters within the cells with whitespace

pub fn set_char( &mut self, x: usize, y: usize, c: char, style: &Style, theme: &Theme, )

Add a character to a buffer cell with appropriate styling and theme

Arguments

• x: The x coordinate of the cell
• y: The y coordinate of the cell
• c: The character to emplace
• style: The styling of the character and its encapsulating cell
• theme: The theme to use for styling

pub fn set_text(&mut self, x: usize, y: usize, text: &str, style: &Style)

Adds a string of text to the buffer with appropriate styling

Arguments

• x: The x coordinate representing the start of the text’s destination within the buffer
• y: The y coordinate representing the start of the text’s destination within the buffer
• text: The text to emplace
• style: The styling to apply to the text on a cell-wise basis

pub fn diff(&self, other: &RenderBuffer) -> Vec<Change<'_>>

Computes the differences between two RenderBuffers

Arguments

• other: The buffer being compared to the current buffer

Returns

• A vector of Changes which contains information about which positions and cells differ

Trait Implementations

impl Clone for RenderBuffer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderBuffer

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

Formats the value using the given formatter.