stylish 0.1.0

Yet another crate implementing colorized text
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

#![no_std]
#![doc = include_str!("../README.md")]
#![warn(missing_copy_implementations)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![warn(trivial_casts)]
#![warn(trivial_numeric_casts)]
#![warn(unused_extern_crates)]
#![warn(unused_import_braces)]
#![warn(variant_size_differences)]
#![doc(test(attr(deny(warnings))))]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

#[cfg(feature = "std")]
extern crate std;

#[cfg(all(doc, feature = "alloc"))]
extern crate alloc;

#[cfg(doc)]
extern crate self as stylish;

#[cfg(all(doc, not(feature = "std")))]
use core::fmt as doc_fmt;
#[cfg(all(doc, feature = "std"))]
use std::fmt as doc_fmt;

#[cfg(all(feature = "alloc", feature = "macros"))]
pub use stylish_core::ToStylishString;
#[cfg(feature = "alloc")]
pub use stylish_core::{format, String};
#[cfg(feature = "macros")]
pub use stylish_core::{format_args, write, writeln};
pub use stylish_core::{
    Arguments, Background, Color, Display, Error, Foreground, Formatter, Intensity, Restyle,
    Result, Style, StyleDiff, Write,
};

#[cfg(feature = "std")]
pub mod io {
    //! Traits and associated types for writing attributed data to fallible
    //! IO sinks.

    #[cfg(feature = "ansi")]
    pub use stylish_ansi::io::Ansi;
    pub use stylish_core::io::{Error, ErrorKind, Result, Write};

    #[cfg(feature = "ansi")]
    /// An alias for [`stylish::io::Ansi::new`] for more succinct code.
    ///
    /// ```rust
    /// let mut writer = stylish::io::ansi(Vec::new());
    /// stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
    /// assert_eq!(writer.finish()?, b"Hello \x1b[31mFerris\x1b[0m");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    pub fn ansi<T: std::io::Write>(inner: T) -> Ansi<T> {
        Ansi::new(inner)
    }

    #[cfg(feature = "plain")]
    pub use stylish_plain::io::Plain;

    #[cfg(feature = "plain")]
    /// An alias for [`stylish::io::Plain::new`] for more succinct code.
    ///
    /// ```rust
    /// let mut writer = stylish::io::plain(Vec::new());
    /// stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
    /// assert_eq!(writer.into_inner(), b"Hello Ferris");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    pub fn plain<T: std::io::Write>(inner: T) -> Plain<T> {
        Plain::new(inner)
    }
}

#[cfg(feature = "ansi")]
/// An alias for [`stylish::Ansi::new`] for more succinct code.
///
/// ```rust
/// let mut writer = stylish::ansi(String::new());
/// stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
/// assert_eq!(writer.finish()?, "Hello \x1b[31mFerris\x1b[0m");
/// # Ok::<(), core::fmt::Error>(())
/// ```
pub fn ansi<T: core::fmt::Write>(inner: T) -> Ansi<T> {
    Ansi::new(inner)
}

#[cfg(feature = "html")]
/// An alias for [`stylish::Html::new`] for more succinct code.
///
/// ```rust
/// let mut writer = stylish::html(String::new());
/// stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
/// assert_eq!(
///     writer.finish()?,
///     "Hello <span style=color:red>Ferris</span>",
/// );
/// # Ok::<(), core::fmt::Error>(())
/// ```
pub fn html<T: core::fmt::Write>(inner: T) -> Html<T> {
    Html::new(inner)
}

#[cfg(feature = "plain")]
/// An alias for [`stylish::Plain::new`] for more succinct code.
///
/// ```rust
/// let mut writer = stylish::plain(String::new());
/// stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
/// assert_eq!(writer.into_inner(), "Hello Ferris");
/// # Ok::<(), core::fmt::Error>(())
/// ```
pub fn plain<T: core::fmt::Write>(inner: T) -> Plain<T> {
    Plain::new(inner)
}

#[cfg(feature = "ansi")]
pub use stylish_ansi::Ansi;
#[cfg(all(feature = "ansi", feature = "alloc", feature = "macros"))]
pub use stylish_ansi::ToAnsiString;
#[cfg(feature = "ansi")]
pub mod ansi {
    //! Helpers for writing styles as ANSI escape codes.

    #[cfg(feature = "alloc")]
    pub use stylish_ansi::format;
}

#[cfg(feature = "html")]
pub use stylish_html::Html;
#[cfg(all(feature = "html", feature = "alloc", feature = "macros"))]
pub use stylish_html::ToHtmlString;
#[cfg(feature = "html")]
pub mod html {
    //! Helpers for writing styles as HTML elements.

    #[cfg(feature = "alloc")]
    pub use stylish_html::format;
}

#[cfg(feature = "plain")]
pub use stylish_plain::Plain;
#[cfg(all(feature = "plain", feature = "alloc", feature = "macros"))]
pub use stylish_plain::ToPlainString;
#[cfg(feature = "plain")]
pub mod plain {
    //! Helpers for discarding styles.

    #[cfg(feature = "alloc")]
    pub use stylish_plain::format;
}