Struct FancyPrinter

pub struct FancyPrinter { /* private fields */ }

Struct to print text to the stdout using various animations

Example

The example below builds a FancyPrinter that uses the CharacterCycling animation with a delay of 2ms between frames, with frames being printed on the same line and respects newline characters. It then prints “Hello, world!”.

use fancy_print::{FancyPrinter, Animation};
use std::time::Duration;

let printer = FancyPrinter::builder()
    .animation(Animation::CharacterCycling)
    .time_delay(Duration::from_millis(2))
    .multi_line(false)
    .ignore_newlines(false)
    .build();

printer.print("Hello, world!");

The options used in the above example are the defaults for the FancyPrinterBuilder struct which is returned when the builder() function is called.

let printer = FancyPrinter::builder()
    .animation(Animation::CharacterCycling)
    .time_delay(Duration::from_millis(2))
    .multi_line(false)
    .ignore_newlines(false)
    .build();

let default_printer = FancyPrinter::builder().build();

assert_eq!(printer, default_printer);

Implementations

impl FancyPrinter

pub fn builder() -> FancyPrinterBuilder

Returns a FancyPrinterBuilder to construct a new FancyPrinter with

pub fn print<T: ToString>(&self, text: T)

Prints the given text with the FancyPrinter

Panics

Panics if text isn’t ASCII

Trait Implementations

impl Debug for FancyPrinter

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

Formats the value using the given formatter.

impl Default for FancyPrinter

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FancyPrinter

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

impl StructuralPartialEq for FancyPrinter