ublx 0.1.3

TUI to index once, enrich with metadata, and browse a flat snapshot in a 3-pane layout with multiple modes.
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

/// Chars to subtract from toast width for borders + level prefix (e.g. ` [W] `) when word-wrapping bumper messages.
pub const TOAST_CONTENT_WIDTH_OFFSET: usize = 7;

pub struct ToastConfig {
    pub width: u16,
    /// Default max height (rows). Toast height is derived from content (\\n breaks + message count), clamped to this.
    pub height: u16,
    /// Fixed rows (e.g. top border+title, bottom border) added to content lines when computing toast height.
    pub toast_height_offset: u16,
    /// Minimum toast height in rows (content + offset is clamped to at least this).
    pub toast_height_min: u16,
    pub hz_padding: u16,
    pub vt_padding: u16,
    pub duration: std::time::Duration,
    pub display_lines: usize,
    pub bumper_cap: usize,
    /// Dev mode: larger toast and more lines.
    pub dev_width: u16,
    pub dev_height: u16,
    pub dev_display_lines: usize,
    pub dev_bumper_cap: usize,
    /// Max number of toasts to show stacked at once (oldest dropped when exceeded).
    pub max_toast_stack: usize,
    /// Vertical gap (rows) between stacked toasts.
    pub toast_stack_gap: u16,
}

/// Pick `dev_val` when `dev` is true, else `normal`. Used by `ToastConfig` `*_for(dev)` methods.
fn pick<T>(dev: bool, normal: T, dev_val: T) -> T {
    if dev { dev_val } else { normal }
}

impl Default for ToastConfig {
    fn default() -> Self {
        Self::new()
    }
}

impl ToastConfig {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            width: 44,
            height: 10,
            toast_height_offset: 2,
            toast_height_min: 3,
            hz_padding: 1,
            vt_padding: 2,
            duration: std::time::Duration::from_secs(4),
            display_lines: 2,
            bumper_cap: 100,
            dev_width: 100,
            dev_height: 20,
            dev_display_lines: 10,
            dev_bumper_cap: 500,
            max_toast_stack: 3,
            toast_stack_gap: 1,
        }
    }

    #[must_use]
    pub fn bumper_cap_for(&self, dev: bool) -> usize {
        pick(dev, self.bumper_cap, self.dev_bumper_cap)
    }

    #[must_use]
    pub fn width_for(&self, dev: bool) -> u16 {
        pick(dev, self.width, self.dev_width)
    }

    #[must_use]
    pub fn height_for(&self, dev: bool) -> u16 {
        pick(dev, self.height, self.dev_height)
    }

    #[must_use]
    pub fn display_lines_for(&self, dev: bool) -> usize {
        pick(dev, self.display_lines, self.dev_display_lines)
    }

    /// Number of bumper messages to show in a toast. Height is derived from content (see [`crate::utils::notifications::toast_content_line_count`]).
    #[must_use]
    pub fn display_lines_for_operation(&self, dev: bool, _operation: Option<&str>) -> usize {
        self.display_lines_for(dev)
    }

    /// Width available for message text when wrapping (width minus [`TOAST_CONTENT_WIDTH_OFFSET`]).
    #[must_use]
    pub fn content_width_for(&self, dev: bool) -> usize {
        (self.width_for(dev) as usize).saturating_sub(TOAST_CONTENT_WIDTH_OFFSET)
    }
}

pub const TOAST_CONFIG: ToastConfig = ToastConfig::new();

/// Operation names for toasts and bumper grouping: `{executable}: {name}` (e.g. `ublx: snapshot`, `ublx: lens`).
pub struct OperationName {
    executable: &'static str,
}

impl Default for OperationName {
    fn default() -> Self {
        Self::new()
    }
}

impl OperationName {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            executable: env!("CARGO_PKG_NAME"),
        }
    }

    /// e.g. `op("snapshot")` → `"ublx: snapshot"`, `op("theme-selector")` → `"ublx: theme-selector"`.
    #[must_use]
    pub fn op(&self, name: &str) -> String {
        format!("{}: {}", self.executable, name)
    }
}

pub const OPERATION_NAME: OperationName = OperationName::new();