Struct FigletBuilder 

pub struct FigletBuilder { /* private fields */ }

Fluent builder for Figlet renderers.

Construct via FigletBuilder::new and chain configuration methods (#[must_use]); terminate with FigletBuilder::build to obtain a reusable Figlet, or use FigletBuilder::render as a one-shot.

use rusty_figlet::{FigletBuilder, Font};

let figlet = FigletBuilder::new()
    .font(Font::Standard)
    .width(80)
    .build()
    .expect("build");
let _banner = figlet.render("X").expect("render");

Implementations

impl FigletBuilder

pub fn new() -> Self

Construct a builder with all defaults:

• font: Font::Standard (resolves to standard.flf)
• width: 80 columns
• layout: font-default
• justify: font-default

pub fn font(self, font: Font) -> Self

Select a font.

When font is one of the 12 bundled variants, build resolves the embedded .flf bytes via include_bytes!. When font is Font::External, the supplied path is resolved at build() time. Default: Font::Standard.

pub fn font_bytes(self, bytes: &[u8]) -> Self

Supply raw .flf bytes directly (no filesystem access; FR-052 + FR-056). Overrides any prior font call.

pub fn font_dirs(self, dirs: Vec<PathBuf>) -> Self

Add an extra directory to search for Font::External resolutions (CLI -d <dir> counterpart per FR-010). Repeatable; directories are searched in the order added. Has no effect on bundled or font_bytes sources.

pub fn width(self, cols: u32) -> Self

Set the output width budget in columns. Default: 80.

pub fn kerning(self) -> Self

Force horizontal kerning (-k CLI counterpart). Overrides the font’s default layout. Last layout-override wins.

pub fn full_width(self) -> Self

Force full-width layout (-W CLI counterpart). Overrides the font’s default layout. Last layout-override wins.

pub fn smush(self) -> Self

Force smushing per the font’s smush bits (-S CLI counterpart). Overrides the font’s default layout. Last layout-override wins.

pub fn layout(self, flags: LayoutFlags) -> Self

Apply a full sequence of layout-class flag occurrences with last-wins semantics (FR-023). When non-empty, this sequence supersedes any per-method kerning / full_width / smush override.

use rusty_figlet::{FigletBuilder, LayoutFlag, LayoutFlags};

let flags = LayoutFlags {
    flags: vec![LayoutFlag::FullWidth, LayoutFlag::Kerning],
};
let _ = FigletBuilder::new().layout(flags);

pub fn justify(self, j: Justify) -> Self

Set the justification mode. Default: font’s print-direction default.

pub fn build(self) -> Result<Figlet, FigletError>

Resolve the font, parse the .flf, and build a reusable Figlet renderer.

pub fn render(self, text: &str) -> Result<Banner, FigletError>

Terminal convenience equivalent to self.build()?.render(text).

Trait Implementations

impl Clone for FigletBuilder

fn clone(&self) -> FigletBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FigletBuilder

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

Formats the value using the given formatter.

impl Default for FigletBuilder

fn default() -> Self

Returns the “default value” for a type.