Struct txtframe::TextFrame

pub struct TextFrame { /* private fields */ }

The abstract representation of a TextFrame.

Examples

let mut text_frame = TextFrame::new()
    .frame_var(&FrameVar::Space)
    .algn(Algn::Centr)
    .color_fra(Color::Red)
    .color_txt(Color::Cyan)
    .color_fill(Color::Magenta)
    .expand(2)
    .width(10)
    .expand_width(2)
    .expand_height(2)
    .left_top('┏')
    .top_line('╍')
    .right_top('┓')
    .vert_left('┋')
    .vert_right('┋')
    .left_btm('┗')
    .btm_line('╍')
    .right_btm('┛')
    .fill('░');

Implementations

impl TextFrame

pub fn new() -> Self

Construct an empty frame.

pub fn frame_var(self, vars: &FrameVar) -> Self

Select preset frames.

pub fn frame_iter<'a>(&'a self, text: &'a str) -> impl Iterator<Item = &str>

Create an iterator frame.

pub fn left_top(self, ch: char) -> Self

Value for top left corner.

pub fn top_line(self, ch: char) -> Self

Value for top line.

pub fn right_top(self, ch: char) -> Self

Value for top right corner.

pub fn vert_left(self, ch: char) -> Self

Value for left vertical line.

pub fn vert_right(self, ch: char) -> Self

Value for right vertical line.

pub fn left_btm(self, ch: char) -> Self

Value for bottom left corner.

pub fn btm_line(self, ch: char) -> Self

Value for bottom line.

pub fn right_btm(self, ch: char) -> Self

Value for bottom right corner.

pub fn width(self, width: usize) -> Self

Value for frame width.

pub fn height(self, height: usize) -> Self

Value for frame height.

pub fn expand_width(self, width: usize) -> Self

Value for frame width expand.

pub fn expand_height(self, height: usize) -> Self

Value for frame height expand.

pub fn expand(self, expand: usize) -> Self

Value for frame expand.

pub fn algn(self, algn: Algn) -> Self

Value for align expand.

pub fn fill(self, fill: char) -> Self

Value for fill expand.

pub fn color_fra(self, color: Color) -> Self

Specifies the frame color.

pub fn color_txt(self, color: Color) -> Self

Specifies the text color.

pub fn color_fill(self, color: Color) -> Self

Specifies the fill color.

Trait Implementations

impl Clone for TextFrame

fn clone(&self) -> TextFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextFrame

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

Formats the value using the given formatter.

impl Default for TextFrame

fn default() -> TextFrame

Returns the “default value” for a type.

impl PartialEq<TextFrame> for TextFrame

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for TextFrame

impl StructuralEq for TextFrame

impl StructuralPartialEq for TextFrame