ransi 1.0.0

ransi - Utility for ANSI escape codes
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

use std::io::{self, Write};

/// bold(text: &str) -> String - Bold an string
///
/// This function takes a string slice as an input and returns a new string that,
/// when printed, will appear in bold.
///
/// # Examples
///
/// ```
/// use ransi::layout::bold;
///
/// let important_text: &str = "This is really important!";
/// println!("{}", bold(important_text));
/// ```
pub fn bold(text: &str) -> String {
    format!("\x1b[1m{}\x1b[22m", text)
}

/// blink(text: &str) -> String - Makes text blink
///
/// This function takes a string slice as an input and returns a new string that,
/// when printed, will blink.
///
/// # Examples
///
/// ```
/// use ransi::layout::blink;
///
/// let text = "This text will blink";
///
/// let blink_text = blink(text);
///
/// println!("{}", blink_text);
/// println!("This text is not blinking.");
/// ```
pub fn blink(text: &str) -> String {
    let blink = format!("\x1B[5m{}\x1B[25m", text); // NOTE: use 25m to reset the blink
	io::stdout().flush().unwrap();
	blink
}

/// italic(text: &str) -> String - Makes the text italic
///
/// This function takes a string slice as an input and returns a new string that,
/// when printed, is italic.
///
/// # Examples
///
/// ```
/// use ransi::layout::italic;
///
/// let text1 = "Violets are blue, Roses are red, This is not italic text";
/// let text2 = "Violets are blue, Roses are red, This is italic text";
/// let italic_text = italic(text1);
///
/// println!("{}", text1);
/// println!("And now italic...");
/// println!("{}", text2);
/// ```
pub fn italic(text: &str) -> String {
    format!("\x1B[3m{}\x1B[23m", text)
}