spannify 0.2.5

A crate that produces nice-looking graphs to visualize your callstack.
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

//! Configuration for span generators

use crate::level::Level;

/// Config that determines the ouput of the span generator
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub struct Config<T = fn(usize) -> char>
where
    T: Fn(usize) -> char,
{
    /// Determines how many spaces is added per depth. Default is `2`.
    pub tabwidth: usize,
    /// Determines the frequency of vertical bars. `skip: 2` means a bar is placed every 2 spans. The skip value of 0 means that no bars are displayed. Default is `2`.
    pub skip: usize,
    /// Function that maps the depth of a span to a vertical bar character.
    pub depthmap: T,
    /// Determines the minumum level for the spans. Spans with level below the `level` are
    /// ignored. Deafult is `Level::Info`
    pub level: Level,
}

impl Config {
    /// Creates a `Config` instance with default values
    ///
    /// # Defaults
    /// - `tabwidth`: 2
    /// - `skip`: 2
    /// - `depthmap`: A function that cycles through `['|', '¦', '┆', '┊']`
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }
}

impl<T> Config<T>
where
    T: Fn(usize) -> char,
{
    /// Replaces the function that maps depth to a character.
    ///
    /// # Parameters
    /// - `depthmap`: A new function to map depth to a character.
    ///
    /// # Examples
    /// ```
    /// use spannify::config::Config;
    ///
    /// let config = Config::new().with_depthmap(|depth| if depth % 2 == 0 { '|' } else { '¦' });
    /// ```
    #[must_use]
    pub fn with_depthmap<U: Fn(usize) -> char>(self, depthmap: U) -> Config<U> {
        Config {
            tabwidth: self.tabwidth,
            skip: self.skip,
            depthmap,
            level: self.level,
        }
    }

    /// Replaces the skip value.
    ///
    /// # Parameters
    /// - `skip`: The new frequency for vertical bars.
    ///
    /// # Examples
    /// ```
    /// use spannify::config::Config;
    ///
    /// let config = Config::new().with_skip(4);
    /// ```
    #[must_use]
    pub fn with_skip(self, skip: usize) -> Self {
        Self { skip, ..self }
    }

    /// Replaces the level value.
    ///
    /// # Parameters
    /// - `level`: The new minimum level for the spans.
    ///
    /// # Examples
    /// ```
    /// use spannify::config::Config;
    ///
    /// let config = Config::new().with_skip(4);
    /// ```
    #[must_use]
    pub fn with_level(self, level: Level) -> Self {
        Self { level, ..self }
    }
}

impl Default for Config {
    fn default() -> Self {
        Self {
            tabwidth: 2,
            skip: 2,
            depthmap: default_depthmap,
            level: Level::Info,
        }
    }
}
/// Default function that maps depth to a vertical bar character.
///
/// Cycles through the characters `['|', '¦', '┆', '┊']` based on depth.
const fn default_depthmap(depth: usize) -> char {
    /// A list of vertical bars that we cycle through by default
    const DEPTHMAP: [char; 4] = ['|', '¦', '┆', '┊'];
    DEPTHMAP[depth % DEPTHMAP.len()]
}