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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

---
source: ferritin/src/tests.rs
expression: "render_for_tests(Commands::get(\"crate\"), OutputMode::TestMode)"
---
  Item: test_crate
Kind: Module
Visibility: Public
Defined at: <type-name>test_crate</type-name>
In crate: test-crate (0.1.0)

<truncated level="full">A minimal test crate for rustdoc JSON testing

</truncated>

<section><section-title>Modules</section-title><list>
  <item><label><type-name>link_resolution_tests</type-name></label>
<truncated level="single-line">Module for testing intra-doc link resolution

</truncated>
</item>
  <item><label><type-name>reexport_mod</type-name></label></item>
  <item><label><type-name>submodule</type-name></label>
<truncated level="single-line">A module with items

</truncated>
</item>
</list>
</section><section><section-title>Structs</section-title><list>
  <item><label><type-name>GenericStruct</type-name></label>
<truncated level="single-line">A generic struct for testing multi-paragraph documentation.

This struct <elided chars="409"/></truncated>
</item>
  <item><label><type-name>SubStruct</type-name></label>
<truncated level="single-line">A struct in a submodule

</truncated>
</item>
  <item><label><type-name>TestStruct</type-name></label>
<truncated level="single-line">A simple struct for testing basic functionality.

This struct demonstrates <elided chars="220"/></truncated>
</item>
  <item><label><type-name>TupleStruct</type-name></label>
<truncated level="single-line">A tuple struct for testing

</truncated>
</item>
  <item><label><type-name>UnitStruct</type-name></label>
<truncated level="single-line">A unit struct for testing

</truncated>
</item>
  <item><label><type-name>Vec</type-name></label>
<truncated level="single-line">A contiguous growable array type, written as <inline-code>Vec<T></inline-code>, short for 'vector'.

 <elided chars="8635"/></truncated>
</item>
</list>
</section><section><section-title>Enums</section-title><list>
  <item><label><type-name>GenericEnum</type-name></label>
<truncated level="single-line">A generic enum for testing

See also <link href="https://docs.rs/test-crate/0.1.0/test-crate/submodule/enum.TestEnum.html"><inline-code>crate::TestEnum</inline-code></link>

</truncated>
</item>
  <item><label><type-name>TestEnum</type-name></label>
<truncated level="single-line">An enum for testing

This is like <link href="https://docs.rs/test-crate/0.1.0/test-crate/enum.GenericEnum.html"><inline-code>crate::GenericEnum</inline-code></link> but without the generic

</truncated>
</item>
</list>
</section><section><section-title>Traits</section-title><list>
  <item><label><type-name>ComplexTrait</type-name></label>
<truncated level="single-line">A more complex trait demonstrating various features

</truncated>
</item>
  <item><label><type-name>TestTrait</type-name></label>
<truncated level="single-line">A trait for testing extremely long documentation that exceeds line limits.

This <elided chars="1265"/></truncated>
</item>
</list>
</section><section><section-title>Functions</section-title><list>
  <item><label><type-name>async_function</type-name></label>
<truncated level="single-line">An async function

</truncated>
</item>
  <item><label><type-name>generic_function</type-name></label>
<truncated level="single-line">A generic function

</truncated>
</item>
  <item><label><type-name>sub_function</type-name></label>
<truncated level="single-line">A function in a submodule

</truncated>
</item>
  <item><label><type-name>test_function</type-name></label>
<truncated level="single-line">A public function

</truncated>
</item>
</list>
</section><section><section-title>Constants</section-title><list>
  <item><label><type-name>TEST_CONSTANT</type-name></label>
<truncated level="single-line">A const for testing

</truncated>
</item>
</list>
</section><section><section-title>Statics</section-title><list>
  <item><label><type-name>TEST_STATIC</type-name></label>
<truncated level="single-line">A static for testing

</truncated>
</item>
</list>
</section><section><section-title>Variants</section-title><list>
  <item><label><type-name>VariantA</type-name></label>
<truncated level="single-line">Variant A (see also <link href="https://docs.rs/test-crate/0.1.0/test-crate/enum.GenericEnum.html"><inline-code>crate::GenericEnum</inline-code></link>)

</truncated>
</item>
  <item><label><type-name>VariantB</type-name></label>
<truncated level="single-line">Variant B with data

</truncated>
</item>
  <item><label><type-name>VariantC</type-name></label>
<truncated level="single-line">Variant C with struct data (<inline-code>name</inline-code> and <inline-code>value</inline-code>)

</truncated>
</item>
</list>
</section>