Struct boxx::Boxx

pub struct Boxx {
    pub config: Config,
}

Boxx is a customizable data structure that will pretty print content separated by newlines (\n).

Fields

config: Config

Display configuration of the Boxx. This field dictates how a Boxx will be displayed in the terminal.

Methods

impl Boxx

pub fn default() -> Boxx

Create a Boxx with deafult configuration.

Example

use boxx::Boxx;

let boxx = Boxx::default();

pub fn new(config: Config) -> Boxx

Creates a new Boxx from a pre-made Config.

Example

use boxx::{Boxx, Config};

let config = Config::default();
let boxx = Boxx::new(config);

pub fn builder() -> Config

Get a configuration builder to customize the appearance of a Boxx.

Example

use boxx::Boxx;

let boxx = Boxx::builder().padding(3).margin(1).build();

pub fn display(&self, content: &str)

Prints your Boxxed content to stdout If your content is long, separate it with line breaks (\n).

If the user's terminal is too small, or something goes wrong with displaying your content in a box, this function will print the content passed to it with no modifications.

If you would like to handle specific error cases, it is recommended to use .as_str() directly.

Example

use boxx::Boxx;

Boxx::default().display("Hello, World!\nNew lines can be created with the newline separator :).");

pub fn as_str(&self, content: &str) -> Result<String, VisualWidthError>

Get your content in a Boxx as a String.

Example

use boxx::Boxx;

let result = Boxx::default().as_str("Hello, World!")?;
println!("{}", result);

Trait Implementations

impl Clone for Boxx

fn clone(&self) -> Boxx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boxx

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

Formats the value using the given formatter.

impl PartialEq<Boxx> for Boxx

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

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

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

This method tests for !=.

impl StructuralPartialEq for Boxx