shapely-pretty 3.1.0

Pretty-printing for types implementing the Shapely trait
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

//! Display trait implementations for pretty-printing Shapely types

use std::fmt::{self, Display, Formatter};

use crate::printer::PrettyPrinter;

/// Display wrapper for any type that implements Shapely
pub struct PrettyDisplay<'a, T: shapely_core::Shapely> {
    pub(crate) value: &'a T,
    pub(crate) printer: PrettyPrinter,
}

impl<T: shapely_core::Shapely> Display for PrettyDisplay<'_, T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        self.printer.format_to(self.value, f)
    }
}

/// Extension trait for Shapely types to easily pretty-print them
pub trait ShapelyPretty: shapely_core::Shapely {
    /// Get a displayable wrapper that pretty-prints this value
    fn pretty(&self) -> PrettyDisplay<'_, Self>;

    /// Get a displayable wrapper with custom printer settings
    fn pretty_with(&self, printer: PrettyPrinter) -> PrettyDisplay<'_, Self>;
}

impl<T: shapely_core::Shapely> ShapelyPretty for T {
    fn pretty(&self) -> PrettyDisplay<'_, Self> {
        PrettyDisplay {
            value: self,
            printer: PrettyPrinter::default(),
        }
    }

    fn pretty_with(&self, printer: PrettyPrinter) -> PrettyDisplay<'_, Self> {
        PrettyDisplay {
            value: self,
            printer,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use shapely::Shapely;
    use std::fmt::Write;

    // Use the derive macro from shapely
    #[derive(Shapely)]
    struct TestStruct {
        field: u32,
    }

    #[test]
    fn test_pretty_display() {
        let test = TestStruct { field: 42 };
        let display = test.pretty();

        let mut output = String::new();
        write!(output, "{}", display).unwrap();

        // Just check that it contains the field name and doesn't panic
        assert!(output.contains("field"));
    }

    #[test]
    fn test_pretty_with_custom_printer() {
        let test = TestStruct { field: 42 };
        let printer = PrettyPrinter::new().with_colors(false);
        let display = test.pretty_with(printer);

        let mut output = String::new();
        write!(output, "{}", display).unwrap();

        // Just check that it contains the field name and doesn't panic
        assert!(output.contains("field"));
    }
}