rulet 2.0.0

A rusty figlet implementation
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75

#![deny(missing_docs)]
//! ```plain
//!           ____  _   _ _     _____ _____         
//!   _____  |  _ \| | | | |   | ____|_   _|  _____
//!  |_____| | |_) | | | | |   |  _|   | |   |_____|
//!  |_____| |  _ <| |_| | |___| |___  | |   |_____|
//!          |_| \_\\___/|_____|_____| |_|          
//!                                                 
//! ```
//!
//! A crate for drawing FIGlets.
//!
//! The most basic way to use it is as follows:
//! ```rust
//!     use rulet::*
//!
//!     let input = "Hello World!";
//!     let figure = figlet::FIGure::from_text(input);
//!     println!("{figure}");
//! ```
//! which will print:
//! ```plain
//!   _   _      _ _        __        __         _     _ _
//!  | | | | ___| | | ___   \ \      / /__  _ __| | __| | |
//!  | |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` | |
//!  |  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |_|
//!  |_| |_|\___|_|_|\___/     \_/\_/ \___/|_|  |_|\__,_(_)
//!
//! ```
//! in the default `standard` FIGfont. To use another one, you can use [FIGfont]:
//!
//! ```rust
//!     use rulet::*;
//!
//!     let input = "Hello World!";
//!     let font_path = "./small.flf";
//!     let font = FIGfont::from_file(font_path)?;
//!     let figure = FIGure::from_text_with_font(input, &font);
//!     println!("{figure}");
//! ```
//! which will use the given FIGfont, in this case, `small`:
//! ```plain
//!   _  _     _ _      __      __       _    _ _
//!  | || |___| | |___  \ \    / /__ _ _| |__| | |
//!  | __ / -_) | / _ \  \ \/\/ / _ \ '_| / _` |_|
//!  |_||_\___|_|_\___/   \_/\_/\___/_| |_\__,_(_)
//!
//! ```
//!
//! You can also load zipped fonts if you enable the `zip` crate feature

mod figchar;
mod figline;
mod figure;
mod smush_subchars;

#[doc(no_inline)]
pub use figfont::FIGfont;
pub use figure::FIGure;
pub use figure::Options;

#[cfg(test)]
mod tests {
    use figure::Options;

    use crate::*;

    #[test]
    fn basic_writing() {
        let input = "i should make \n proper tests...";
        let options = Options::default().max_width(Some(1000));
        let figure = FIGure::new(input, FIGfont::standard().unwrap(), options);
        println!("{figure}");
    }
}