term-rustdoc 0.2.0

A TUI for Rust docs.
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

use crate::ui::scrollable::render_line;
use ratatui::{
    prelude::{Buffer, Rect, Style, Widget},
    widgets::Block,
};
use unicode_width::UnicodeWidthStr;

#[derive(Default, Debug)]
pub struct Surround {
    block: Block<'static>,
    area: Rect,
}

impl Surround {
    pub fn new(block: Block<'static>, area: Rect) -> Self {
        Surround { block, area }
    }

    pub fn inner(&self) -> Rect {
        self.block.inner(self.area)
    }

    pub fn block_mut(&mut self) -> &mut Block<'static> {
        &mut self.block
    }

    pub fn render(&self, buf: &mut Buffer) {
        (&self.block).render(self.area, buf);
    }

    pub fn area(&self) -> Rect {
        self.area
    }

    /// Update the border area and then return inner area only when the outer areas differ.
    pub fn update_area(&mut self, area: Rect) -> Option<Rect> {
        if self.area == area {
            return None;
        }
        self.area = area;
        Some(self.inner())
    }

    pub fn render_only_bottom_right_text(&self, buf: &mut Buffer, text: &str) -> usize {
        let area = self.area;
        let text_width = text.width();
        if let Some(offset) = (area.width as usize).checked_sub(2 + text_width) {
            let x = area.x + offset as u16;
            let y = area.y + area.height - 1;
            render_line(Some((text, Style::new())), buf, x, y, text_width);
            return text_width + 2;
        }
        0
    }

    pub fn render_only_bottom_left_text(&self, buf: &mut Buffer, text: &str, used: usize) {
        let area = self.area;
        if let Some(rest) = (area.width as usize).checked_sub(2 + used) {
            if rest < text.width() {
                // not enought space to show
                return;
            }
            let x = area.x + 2;
            let y = area.y + area.height - 1;
            render_line(Some((text, Style::new())), buf, x, y, rest);
        }
    }

    pub fn render_only_top_left_text(&self, buf: &mut Buffer, text: &str, used: usize) {
        let area = self.area;
        if let Some(rest) = (area.width as usize).checked_sub(2 + used) {
            if rest < text.width() {
                // not enought space to show
                return;
            }
            let x = area.x + 2;
            let y = area.y;
            render_line(Some((text, Style::new())), buf, x, y, rest);
        }
    }
}