ferritin 0.1.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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

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 doc_nodes = vec![
            DocumentNode::Span(Span::plain("\n")),
            DocumentNode::Span(Span::keyword("type")),
            DocumentNode::Span(Span::plain(" ")),
            DocumentNode::Span(Span::type_name(name)),
            DocumentNode::Span(Span::plain(" ")),
            DocumentNode::Span(Span::operator("=")),
            DocumentNode::Span(Span::plain(" ")),
        ];

        // Add type spans
        doc_nodes.extend(
            self.format_type(item, &type_alias.item().type_)
                .into_iter()
                .map(DocumentNode::Span),
        );

        doc_nodes.push(DocumentNode::Span(Span::punctuation(";")));
        doc_nodes.push(DocumentNode::Span(Span::plain("\n")));

        doc_nodes
    }

    /// 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::Span(Span::plain("\n")),
            DocumentNode::Span(Span::plain("[Union formatting not yet implemented]")),
            DocumentNode::Span(Span::plain("\n")),
        ]
    }

    /// 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 doc_nodes = vec![
            DocumentNode::Span(Span::plain("\n")),
            DocumentNode::Span(Span::keyword("const")),
            DocumentNode::Span(Span::plain(" ")),
            DocumentNode::Span(Span::plain(name)),
            DocumentNode::Span(Span::punctuation(":")),
            DocumentNode::Span(Span::plain(" ")),
        ];

        // Add type spans
        doc_nodes.extend(
            self.format_type(item, type_)
                .into_iter()
                .map(DocumentNode::Span),
        );

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

        doc_nodes.push(DocumentNode::Span(Span::punctuation(";")));
        doc_nodes.push(DocumentNode::Span(Span::plain("\n")));

        doc_nodes
    }

    /// 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 doc_nodes = vec![
            DocumentNode::Span(Span::plain("\n")),
            DocumentNode::Span(Span::keyword("static")),
            DocumentNode::Span(Span::plain(" ")),
            DocumentNode::Span(Span::plain(name)),
            DocumentNode::Span(Span::punctuation(":")),
            DocumentNode::Span(Span::plain(" ")),
        ];

        // Add type spans
        doc_nodes.extend(
            self.format_type(item, &static_item.type_)
                .into_iter()
                .map(DocumentNode::Span),
        );

        doc_nodes.push(DocumentNode::Span(Span::plain(" ")));
        doc_nodes.push(DocumentNode::Span(Span::operator("=")));
        doc_nodes.push(DocumentNode::Span(Span::plain(" ")));
        doc_nodes.push(DocumentNode::Span(Span::inline_code(&static_item.expr)));
        doc_nodes.push(DocumentNode::Span(Span::punctuation(";")));
        doc_nodes.push(DocumentNode::Span(Span::plain("\n")));

        doc_nodes
    }
}