Struct AnsiBuilder

Source

pub struct AnsiBuilder(/* private fields */);

Implementations§

Source §

impl AnsiBuilder

Source

pub fn new() -> Self

Examples found in repository ?

examples/color.rs (line 7)

1fn main() {
2    #[cfg(windows)]
3    if !ansi_builder::enable_ansi_color() {
4        println!("Failed to enable_ansi_color.");
5    }
6
7    AnsiBuilder::new()
8        .text("Hello, World! ")
9        .color().fg().red()
10        .text("Hello, World but in red!")
11        .println()
12        .color().fg().bright_blue()
13        .color().bg().red()
14        .text("Another sample text")
15        .reset_attributes()
16        .text(" Everything is reverted")
17        .println();
18}

More examples

Hide additional examples

examples/styles.rs (line 2)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}

Source

pub fn erase_line(self, mode: ClearMode) -> Self

Source

pub fn cursor(self) -> Cursor

Source

pub fn color(self) -> Color

Examples found in repository ?

examples/color.rs (line 9)

1fn main() {
2    #[cfg(windows)]
3    if !ansi_builder::enable_ansi_color() {
4        println!("Failed to enable_ansi_color.");
5    }
6
7    AnsiBuilder::new()
8        .text("Hello, World! ")
9        .color().fg().red()
10        .text("Hello, World but in red!")
11        .println()
12        .color().fg().bright_blue()
13        .color().bg().red()
14        .text("Another sample text")
15        .reset_attributes()
16        .text(" Everything is reverted")
17        .println();
18}

Source

pub fn text(self, string: &str) -> Self

Examples found in repository ?

examples/color.rs (line 8)

1fn main() {
2    #[cfg(windows)]
3    if !ansi_builder::enable_ansi_color() {
4        println!("Failed to enable_ansi_color.");
5    }
6
7    AnsiBuilder::new()
8        .text("Hello, World! ")
9        .color().fg().red()
10        .text("Hello, World but in red!")
11        .println()
12        .color().fg().bright_blue()
13        .color().bg().red()
14        .text("Another sample text")
15        .reset_attributes()
16        .text(" Everything is reverted")
17        .println();
18}

More examples

Hide additional examples

examples/styles.rs (line 4)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}

Source

pub fn erase_in_display(self, mode: EraseMode) -> Self

Source

pub fn print(self) -> Self

Examples found in repository ?

examples/styles.rs (line 67)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}

Source

pub fn println(self) -> Self

Examples found in repository ?

examples/color.rs (line 11)

1fn main() {
2    #[cfg(windows)]
3    if !ansi_builder::enable_ansi_color() {
4        println!("Failed to enable_ansi_color.");
5    }
6
7    AnsiBuilder::new()
8        .text("Hello, World! ")
9        .color().fg().red()
10        .text("Hello, World but in red!")
11        .println()
12        .color().fg().bright_blue()
13        .color().bg().red()
14        .text("Another sample text")
15        .reset_attributes()
16        .text(" Everything is reverted")
17        .println();
18}

More examples

Hide additional examples

examples/styles.rs (line 6)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}

Source

pub fn reset_attributes(self) -> Self

Examples found in repository ?

examples/color.rs (line 15)

1fn main() {
2    #[cfg(windows)]
3    if !ansi_builder::enable_ansi_color() {
4        println!("Failed to enable_ansi_color.");
5    }
6
7    AnsiBuilder::new()
8        .text("Hello, World! ")
9        .color().fg().red()
10        .text("Hello, World but in red!")
11        .println()
12        .color().fg().bright_blue()
13        .color().bg().red()
14        .text("Another sample text")
15        .reset_attributes()
16        .text(" Everything is reverted")
17        .println();
18}

More examples

Hide additional examples

examples/styles.rs (line 15)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}

Source

pub fn style(self) -> Style

Examples found in repository ?

examples/styles.rs (line 3)

1fn main() {
2    AnsiBuilder::new()
3        .style().underline()
4        .text("Underlined")
5        .style().remove_underline()
6        .println()
7
8        .style().italic()
9        .text("italic")
10        .style().remove_italic()
11        .println()
12
13        .style().dim()
14        .text("dim text ")
15        .reset_attributes()
16        .text("not dim")
17        .println()
18
19        .style().double_underline()
20        .text("double_underline")
21        .style().remove_underline()
22        .println()
23
24        .style().strike()
25        .text("striked text")
26        .style().remove_strike()
27        .println()
28
29        .style().rapid_blink()
30        .text("rapid bliking text (not widely supported) ")
31        .style().remove_blink()
32        .println()
33
34        .style().slow_blink()
35        .text("slow blink text")
36        .style().remove_blink()
37        .println()
38
39        .style().conceal()
40        .text("Hidden text")
41        .style().reveal()
42        .println()
43
44        .style().strike()
45        .style().double_underline()
46        .text("multi-style")
47        .reset_attributes()
48        .println()
49
50
51        .style().frame()
52        .text("framed text")
53        .style().remove_frame_and_encircle()
54        .println()
55
56        .style().overline()
57        .text("Overlined text")
58        .style().remove_overline()
59        .println()
60
61        .style().encircle()
62        .text("encircle")
63        .style().remove_frame_and_encircle()
64        .println()
65
66        .reset_attributes()
67        .print();
68}