Struct billboard::Billboard

pub struct Billboard {
    pub config: Config,
}

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

Fields

config: Config

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

Methods

impl Billboard

pub fn default() -> Billboard

Create a Billboard with deafult configuration.

Example

use billboard::Billboard;

let billboard = Billboard::default();

pub fn new(config: Config) -> Billboard

Creates a new Billboard from a pre-made Config.

Example

use billboard::{Billboard, Config};

let config = Config::default();
let billboard = Billboard::new(config);

pub fn builder() -> Config

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

Example

use billboard::Billboard;

let billboard = Billboard::builder().padding(3).margin(1).build();

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

Prints your Billboarded 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 billboard::Billboard;

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

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

Get your content in a Billboard as a String.

Example

use billboard::Billboard;

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

Trait Implementations

impl Clone for Billboard

fn clone(&self) -> Billboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Billboard

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

Formats the value using the given formatter.

impl PartialEq<Billboard> for Billboard

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

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

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

This method tests for !=.

impl StructuralPartialEq for Billboard