to-display 0.1.2

A trait that is Display or can be converted to Display
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

use crate::context::LocalOrUTC;
use crate::Context;

/// A customizable display wrapper.
///
/// Provides a builder-style interface to control how values are formatted when displayed.
/// Supports configuration of:
/// - Verbosity level (e.g., `Some(1)` vs `1`)
/// - Collection size limits
/// - Time formatting options (timezone and format patterns)
///
/// # Example:
/// ```
/// use to_display::DisplayConfig;
/// use to_display::ToDisplay;
///
/// assert_eq!(Some(1u32).display().to_string(), "1");
/// assert_eq!(Some(1u32).display().verbose().to_string(), "Some(1)");
/// ```
///
/// [`ToDisplay::display()`]: crate::ToDisplay::display
pub trait DisplayConfig: Sized {
    /// Return a mutable reference to the context to let the caller modify it.
    fn context_mut(&mut self) -> &mut Context;

    /// Enable verbose mode: Display [`Option`] with `Some(v)/None` or `v/-`
    fn verbose(mut self) -> Self {
        self.context_mut().verbose = Some(true);
        self
    }

    /// Set the maximum number of items to display for collections.
    ///
    /// Applies to slices, vectors, maps, and other collection types.
    /// Elements beyond this limit will be indicated with an ellipsis.
    fn limit_items(mut self, max_items: usize) -> Self {
        self.context_mut().max_items = Some(max_items);
        self
    }

    /// Configures timestamps to display in local time.
    fn use_local_time(mut self) -> Self {
        self.context_mut().local_or_utc = Some(LocalOrUTC::Local);
        self
    }

    /// Configures timestamps to display in UTC.
    fn use_utc_time(mut self) -> Self {
        self.context_mut().local_or_utc = Some(LocalOrUTC::Utc);
        self
    }

    /// Sets a concise time format (`%H:%M:%S%.6f`).
    fn use_short_time(mut self) -> Self {
        self.context_mut().time_format = Some("SIMPLE");
        self
    }

    /// Sets a detailed time format (`%Y-%m-%dT%H:%M:%S%.6fZ%z`).
    fn use_full_time(mut self) -> Self {
        self.context_mut().time_format = Some("FULL");
        self
    }

    /// Sets a custom time format string.
    ///
    /// Uses the format syntax from the `chrono` crate.
    /// See [chrono::format::strftime](https://docs.rs/chrono/latest/chrono/format/strftime/index.html)
    /// for the full specification.
    fn with_time_format(mut self, time_format: &'static str) -> Self {
        self.context_mut().time_format = Some(time_format);
        self
    }
}