stylish-plain 0.1.0

`stylish` helpers for discarding styles
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

use alloc::string::String;

use stylish_core::Display;

use crate::format;

/// A trait for converting a value to a [`String`] without styling.
///
/// This trait is automatically implemented for any type which implements the
/// [`stylish::Display`] trait. As such, `ToPlainString` shouldn’t be
/// implemented directly: [`stylish::Display`] should be implemented instead,
/// and you get the `ToPlainString` implementation for free.
///
/// [`stylish::Display`]: `stylish_core::Display`
pub trait ToPlainString {
    /// Converts the given value to a [`String`] without styling.
    ///
    /// ```rust
    /// struct Warning(&'static str);
    ///
    /// impl stylish::Display for Warning {
    ///     fn fmt(&self, f: &mut stylish::Formatter<'_>) -> stylish::Result {
    ///         f.with(stylish::Foreground(stylish::Color::Red))
    ///             .write_str(self.0)
    ///     }
    /// }
    ///
    /// use stylish::ToPlainString;
    ///
    /// assert_eq!(Warning("FIRE").to_plain_string(), "FIRE");
    /// ```
    fn to_plain_string(&self) -> String;
}

impl<T> ToPlainString for T
where
    T: Display + ?Sized,
{
    fn to_plain_string(&self) -> String {
        format!("{:s}", self)
    }
}