Struct Frame 

pub struct Frame { /* private fields */ }

A single frame of 3a art, consisting of a grid of cells.

Implementations

impl Frame

pub fn to_svg_frame_bg( &self, palette: &Palette, map: &CSSColorMap, font: &Font, ) -> String

Generates SVG background rectangles for colored cells.

pub fn to_svg_frame_txt_fg( &self, palette: &Palette, map: &CSSColorMap, font: &Font, ) -> String

Generates SVG text with foreground colors.

pub fn to_svg_frame_txt(&self, font: &Font) -> String

Generates SVG text without colors.

pub fn to_svg_frame( &self, colors: bool, palette: &Palette, map: &CSSColorMap, font: &Font, ) -> String

Generates SVG for this frame, optionally with colors.

pub fn to_svg( &self, colors: bool, palette: &Palette, map: &CSSColorMap, font: &Font, ) -> String

Generates a complete SVG document for this frame.

impl Frame

pub fn read_color<R: Read>(lines: &mut Lines<BufReader<R>>) -> Result<Self>

Reads a color-only frame from input lines.

pub fn read_text<R: Read>(lines: &mut Lines<BufReader<R>>) -> Result<Self>

Reads a text-only frame from input lines.

pub fn read_both<R: Read>(lines: &mut Lines<BufReader<R>>) -> Result<Self>

Reads a combined (text+color) frame from input lines.

impl Frame

pub fn color(&self) -> bool

Returns true if the frame contains any color cells.

pub fn width(&self) -> usize

Returns the width of the frame in cells.

pub fn height(&self) -> usize

Returns the height of the frame in cells.

pub fn remove_color(&mut self, color: Char)

pub fn crop(&mut self, r_from: usize, r_to: usize, c_from: usize, c_to: usize)

Crop frame

pub fn shift_right(&mut self, cols: usize, fill: Cell)

Shifts all rows right by cols, filling new cells with fill.

pub fn shift_left(&mut self, cols: usize, fill: Cell)

Shifts all rows left by cols, filling vacated cells with fill.

pub fn shift_down(&mut self, rows: usize, fill: Cell)

Shifts all columns down by rows, filling new cells with fill.

pub fn shift_up(&mut self, rows: usize, fill: Cell)

Shifts all columns up by rows, filling vacated cells with fill.

pub fn fill_area<C, R>(&mut self, columns: C, rows: R, new: Cell)

where C: IntoIterator<Item = usize>, R: IntoIterator<Item = usize>,

Fills a rectangular area defined by column and row iterators with new cell.

pub fn set(&mut self, column: usize, row: usize, new: Cell)

Sets the cell at (column, row) to new.

pub fn get(&self, column: usize, row: usize, default: Cell) -> Cell

Gets the cell at (column, row), returning default if out of bounds.

pub fn adjust(&mut self, width: usize, height: usize, fill: Cell)

Adjusts frame size to at least width and height, filling new cells with fill.

pub fn adjust_width(&mut self, width: usize, fill: Cell)

Adjusts frame width to at least width.

pub fn adjust_height(&mut self, height: usize, fill: Cell)

Adjusts frame height to at least height.

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

Resizes frame to exact width and height, filling new cells with fill.

pub fn resize_width(&mut self, width: usize, fill: Cell)

Resizes width to exact width.

pub fn resize_height(&mut self, height: usize, fill: Cell)

Resizes height to exact height.

pub fn contains(&self, cell: Cell) -> bool

Checks if the frame contains the given cell.

pub fn contains_text(&self, ch: Char) -> bool

Checks if the frame contains the given text character.

pub fn contains_color(&self, col: Char) -> bool

Checks if the frame contains the given color character.

pub fn clean(&mut self)

Clears the frame: sets all text to space and color to default.

pub fn fill(&mut self, fill: Cell)

Fills the entire frame with the given cell.

pub fn fill_text(&mut self, fill: Char)

Fills all text cells with the given character.

pub fn fill_color(&mut self, fill: Option<Char>)

Fills all color cells with the given character (or None).

pub fn print( &mut self, col: usize, row: usize, line: &str, color: Option<Option<Char>>, )

Prints text to frame.

pub fn ansi(&self, palette: &Palette, color: bool) -> String

Renders the frame as ANSI escape sequences.

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

Creates a new frame of given dimensions filled with fill.

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

Formats the frame’s text channel.

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

Formats the frame’s color channel.

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

Formats both text and color channels concatenated.

pub fn fmt_with_colors( &self, f: &mut Formatter<'_>, colors: Option<bool>, ) -> Result

Formats the frame with optional color inclusion.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Display for Frame

Displays the frame in combined text+color format.

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

Formats the value using the given formatter.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Frame

impl StructuralPartialEq for Frame