ferritin 0.8.0

Human-friendly CLI for browsing Rust 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

use super::*;
use crate::styled_string::{DocumentNode, Span};

impl Request {
    /// Format a type alias
    pub(crate) fn format_type_alias<'a>(
        &'a self,
        item: DocRef<'a, Item>,
        type_alias: DocRef<'a, TypeAlias>,
    ) -> Vec<DocumentNode<'a>> {
        let name = item.name().unwrap_or("<unnamed>");

        let mut spans = vec![
            Span::keyword("type"),
            Span::plain(" "),
            Span::type_name(name),
            Span::plain(" "),
            Span::operator("="),
            Span::plain(" "),
        ];

        // Add type spans
        spans.extend(self.format_type(item, &type_alias.item().type_));

        spans.push(Span::punctuation(";"));

        vec![DocumentNode::generated_code(spans)]
    }

    /// Format a union
    pub(crate) fn format_union<'a>(
        &'a self,
        _item: DocRef<'a, Item>,
        _union: DocRef<'a, Union>,
    ) -> Vec<DocumentNode<'a>> {
        // TODO: Implement union formatting
        vec![DocumentNode::paragraph(vec![Span::plain(
            "[Union formatting not yet implemented]",
        )])]
    }

    /// Format a constant
    pub(crate) fn format_constant<'a>(
        &'a self,
        item: DocRef<'a, Item>,
        type_: &'a Type,
        const_: &'a Constant,
    ) -> Vec<DocumentNode<'a>> {
        let name = item.name().unwrap_or("<unnamed>");

        let mut spans = vec![
            Span::keyword("const"),
            Span::plain(" "),
            Span::plain(name),
            Span::punctuation(":"),
            Span::plain(" "),
        ];

        // Add type spans
        spans.extend(self.format_type(item, type_));

        if let Some(value) = &const_.value {
            spans.push(Span::plain(" "));
            spans.push(Span::operator("="));
            spans.push(Span::plain(" "));
            spans.push(Span::inline_code(value));
        }

        spans.push(Span::punctuation(";"));

        vec![DocumentNode::generated_code(spans)]
    }

    /// Format a static
    pub(crate) fn format_static<'a>(
        &'a self,
        item: DocRef<'a, Item>,
        static_item: &'a Static,
    ) -> Vec<DocumentNode<'a>> {
        let name = item.name().unwrap_or("<unnamed>");

        let mut spans = vec![
            Span::keyword("static"),
            Span::plain(" "),
            Span::plain(name),
            Span::punctuation(":"),
            Span::plain(" "),
        ];

        // Add type spans
        spans.extend(self.format_type(item, &static_item.type_));

        spans.push(Span::plain(" "));
        spans.push(Span::operator("="));
        spans.push(Span::plain(" "));
        spans.push(Span::inline_code(&static_item.expr));
        spans.push(Span::punctuation(";"));

        vec![DocumentNode::generated_code(spans)]
    }
}