txtview 0.1.3

A lightweight terminal text viewer with scrolling, wrapping, line numbers, and an optional interactive scrollbar
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

/// Options for a [`TxtView`](crate::TxtView).
///
/// Set only the fields you care about and fill the rest from the defaults:
///
/// ```rust
/// use txtview::TxtViewConfig;
///
/// let config = TxtViewConfig {
///     show_line_numbers: true,
///     ..TxtViewConfig::default()
/// };
/// ```
///
/// Or chain the `with_*` setters, which stay compatible as new options are
/// added:
///
/// ```rust
/// use txtview::TxtViewConfig;
///
/// let config = TxtViewConfig::default()
///     .with_show_line_numbers(true)
///     .with_show_scrollbar(false);
/// ```
/// New options arrive in minor releases (`0.x.0`) and always default to the
/// previous behavior, so an existing viewer only changes look when you opt
/// in. Patches (`0.0.x`) ship only bug fixes and purely additive methods.
#[derive(Debug, Clone)]
pub struct TxtViewConfig {
    /// Show a line-number column on the left side of the viewport.
    pub show_line_numbers: bool,
    /// Show the keybinding help bar at the bottom of the viewport.
    pub show_help_bar: bool,
    /// Show an interactive vertical scrollbar on the right edge. It can be
    /// clicked to jump to a position or dragged to scroll.
    pub show_scrollbar: bool,
    /// Fixed viewport width in columns. `None` uses the terminal width. A
    /// fixed width wider than the terminal is clamped to it, the way the
    /// height is, so writes can never pass the terminal edge. A fixed width
    /// of 0 is lifted to 1 so nothing silently renders blank.
    pub viewport_width: Option<u16>,
    /// Fixed viewport height in rows. `None` uses the terminal height. A
    /// fixed height taller than the terminal is clamped to it, so a viewer
    /// larger than the screen still fits. A fixed height of 0 is lifted to
    /// 1 so nothing silently renders blank.
    pub viewport_height: Option<u16>,
}

impl Default for TxtViewConfig {
    fn default() -> Self {
        TxtViewConfig {
            show_line_numbers: false,
            show_help_bar: true,
            show_scrollbar: true,
            viewport_width: None,
            viewport_height: None,
        }
    }
}

impl TxtViewConfig {
    /// Set whether line numbers are shown.
    #[must_use]
    pub fn with_show_line_numbers(mut self, show: bool) -> Self {
        self.show_line_numbers = show;
        self
    }

    /// Set whether the keybinding help bar is shown.
    #[must_use]
    pub fn with_show_help_bar(mut self, show: bool) -> Self {
        self.show_help_bar = show;
        self
    }

    /// Set whether the interactive scrollbar is shown.
    #[must_use]
    pub fn with_show_scrollbar(mut self, show: bool) -> Self {
        self.show_scrollbar = show;
        self
    }

    /// Set a fixed viewport width in columns. `None` uses the terminal width,
    /// and a width beyond it is clamped down to it.
    #[must_use]
    pub fn with_viewport_width(mut self, width: Option<u16>) -> Self {
        self.viewport_width = width;
        self
    }

    /// Set a fixed viewport height in rows. `None` uses the terminal height,
    /// and a height beyond it is clamped down to it.
    #[must_use]
    pub fn with_viewport_height(mut self, height: Option<u16>) -> Self {
        self.viewport_height = height;
        self
    }
}