figlet-rs 1.0.0

Rust implementation of FIGlet to create ascii art
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use crate::shared::{
    load_font_file, parse_font_content, render, FIGcharacter, FIGure, FontData, HeaderLine,
};
use std::collections::HashMap;

/// FIGlet font, which will hold the mapping from u32 code to FIGcharacter
#[derive(Debug, Clone)]
pub struct FIGlet {
    pub header_line: HeaderLine,
    pub comments: String,
    pub fonts: HashMap<u32, FIGcharacter>,
}

impl FIGlet {
    /// generate FIGlet font from string literal
    pub fn from_content(contents: &str) -> Result<FIGlet, String> {
        Ok(parse_font_content(contents)?.into())
    }

    /// generate FIGlet font from specified file
    pub fn from_file(fontname: &str) -> Result<FIGlet, String> {
        Ok(load_font_file(fontname)?.into())
    }

    /// the standard FIGlet font, which you can find [`fontdb`]
    ///
    /// [`fontdb`]: http://www.figlet.org/fontdb.cgi
    pub fn standard() -> Result<FIGlet, String> {
        Ok(parse_font_content(include_str!("../resources/standard.flf"))?.into())
    }

    /// the small FIGlet font bundled with the crate
    pub fn small() -> Result<FIGlet, String> {
        Ok(parse_font_content(include_str!("../resources/small.flf"))?.into())
    }

    /// the big FIGlet font bundled with the crate
    pub fn big() -> Result<FIGlet, String> {
        Ok(parse_font_content(include_str!("../resources/big.flf"))?.into())
    }

    /// the slant FIGlet font bundled with the crate
    pub fn slant() -> Result<FIGlet, String> {
        Ok(parse_font_content(include_str!("../resources/slant.flf"))?.into())
    }

    /// convert string literal to FIGure
    pub fn convert(&self, message: &str) -> Option<FIGure<'_>> {
        render(&self.header_line, &self.fonts, message)
    }
}

impl From<FontData> for FIGlet {
    fn from(data: FontData) -> Self {
        Self {
            header_line: data.header_line,
            comments: data.comments,
            fonts: data.fonts,
        }
    }
}