Struct Font 

pub struct Font { /* private fields */ }

A font that can be used to render text as ASCII art.

Fonts can be loaded from FIGlet font files (.flf) or created as plain text. Multiple fonts can be combined into a stack for automatic fallback rendering.

Examples

use artbox::Font;

// Load from embedded fonts
let font = artbox::fonts::font("slant").unwrap();

// Create a plain text font (no ASCII art)
let plain = Font::plain();

Implementations

impl Font

pub fn figlet(font: FIGfont) -> Self

Creates a font from a parsed FIGfont.

This is a low-level constructor. Prefer Font::from_file, Font::from_content, or the fonts module for loading fonts.

pub fn from_file(path: &str) -> Result<Self, FontError>

Loads a font from a FIGlet font file (.flf).

Errors

Returns an error if the file cannot be read or contains invalid FIGlet data.

Examples

use artbox::Font;

let font = Font::from_file("/path/to/font.flf")?;

pub fn from_content(contents: &str) -> Result<Self, FontError>

Creates a font from FIGlet font content as a string.

Errors

Returns an error if the content is not valid FIGlet format.

pub fn from_bytes_latin1(bytes: &[u8]) -> Result<Self, FontError>

Creates a font from raw bytes encoded as Latin-1.

This is useful for loading embedded font data. Each byte is interpreted as a Latin-1 character code point.

Errors

Returns an error if the content is not valid FIGlet format.

pub fn from_bytes_utf8(bytes: &[u8]) -> Result<Self, FontError>

Creates a font from raw bytes encoded as UTF-8.

Use this for fonts containing Unicode characters like block elements (█▀▄).

Errors

Returns an error if the bytes are not valid UTF-8 or valid FIGlet format.

pub fn standard() -> Option<Self>

Loads the standard FIGlet font bundled with figlet-rs.

Returns None if the standard font cannot be loaded.

pub fn plain() -> Self

Creates a plain text font that renders text without ASCII art styling.

This is useful as a fallback when FIGlet fonts are too large for the bounds.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a duplicate of the value.

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

Performs copy-assignment from source.