rpf 0.1.6

A framework for creating Rust programs
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// Copyright (C) 2015, Alberto Corona <alberto@0x1a.us>
// All rights reserved. This file is part of rpf, distributed under the
// BSD 3-Clause license. For full terms please see the LICENSE file.

extern crate ansi_term;

use self::ansi_term::Style;
use self::ansi_term::{Colour,ANSIString};
use self::ansi_term::Colour::{Red};

/// Wrapper for `ansi_term::Colour`
pub enum Color {
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Purple,
    Cyan,
    White,
}

/// Trait for creating stylized console printing using `ansi_term`
pub trait Styled {
    /// Creates a bold `ANSIString`
    ///
    /// # Example
    /// ```
    /// use rpf::Styled;
    ///
    /// println!("{}", "Styled string test".bold());
    /// ```
    fn bold(&self) -> ansi_term::ANSIString;

    /// Creates an underlined `ANSIString`
    ///
    /// # Example
    /// ```
    /// use rpf::Styled;
    ///
    /// println!("{}", "Styled string test".underline());
    /// ```
    fn underline(&self) -> ansi_term::ANSIString;

    /// Paints a given string with the color given
    ///
    /// # Example
    /// ```
    /// use rpf::Styled;
    /// use rpf::Color;
    ///
    /// println!("{}", "Styled string test".paint(Color::Yellow));
    /// ```
    fn paint(&self, color: Color) -> ansi_term::ANSIString;
}

impl<T: AsRef<str>> Styled for T {
    fn bold(&self) -> ansi_term::ANSIString {
        Style::default().bold().paint(&self.as_ref())
    }

    fn underline(&self) -> ansi_term::ANSIString {
        Style::default().underline().paint(&self.as_ref())
    }

    fn paint(&self, color: Color) -> ansi_term::ANSIString {
        match color {
            Color::Black   => { Colour::Black.paint(&self.as_ref()) },
            Color::Red     => { Colour::Red.paint(&self.as_ref()) },
            Color::Green   => { Colour::Green.paint(&self.as_ref()) },
            Color::Yellow  => { Colour::Yellow.paint(&self.as_ref()) },
            Color::Blue    => { Colour::Blue.paint(&self.as_ref()) },
            Color::Purple  => { Colour::Purple.paint(&self.as_ref()) },
            Color::Cyan    => { Colour::Cyan.paint(&self.as_ref()) },
            Color::White   => { Colour::White.paint(&self.as_ref()) },
        }
    }
}

#[test]
fn test_styled_bold() {
    assert_eq!(String::from("Styled string test").bold().to_string(),
        Style::default().bold().paint("Styled string test").to_string());
}

#[test]
fn test_styled_underline() {
    assert_eq!(String::from("Styled string test").underline().to_string(),
        Style::default().underline().paint("Styled string test").to_string());
}

#[test]
fn test_styled_paint() {
    assert_eq!(String::from("Styled string test").paint(Color::Yellow).to_string(),
        Colour::Yellow.paint("Styled string test").to_string());
}