Struct Page

pub struct Page { /* private fields */ }

A page is a struct containing text to be printed by ChaosEngine. Pages are the building blocks for the programs made by the engine, they must be used to print text to the output.

Examples

use chaos_engine::Page;

let mut page = Page::new();
page.push("hello, world!");

Implementations

impl Page

pub fn new() -> Self

Instantiate a new page to store text.

pub fn push(&mut self, text: &str)

Push some string to the page. Each push will start on its own line.

pub fn pop(&mut self) -> Option<String>

Pop the last string pushed to the page.

pub fn clear(&mut self)

Clear all raw text from the page.

pub fn text(&self) -> &Vec<String>

Get the stored aligned text.

Aligned text puts paddings and word-wrapping into consideration.

pub fn raw_text(&self) -> &Vec<String>

Get the stored raw text.

pub fn align(&mut self, chaos: &Chaos<'_>)

Align the stored raw text, in other words, convert it to a properly formatted text, respecting paddings and word-wrapping.

Trait Implementations

impl Debug for Page

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

Formats the value using the given formatter.

impl PartialEq for Page

fn eq(&self, other: &Page) -> 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 Page

impl StructuralPartialEq for Page