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

---
source: ferritin/src/tests.rs
expression: "render_for_tests(Commands::get(\"crate::TestStruct\"), OutputMode :: Plain)"
---
Item: TestStruct
Kind: Struct
Visibility: Public
Defined at: fixture_crate::TestStruct
In crate: fixture-crate (0.1.0)

A simple struct for testing basic functionality.

This struct demonstrates basic usage patterns and should show completely since it only has one paragraph of documentation.

It uses Vector for testing intra-doc link resolution with renamed imports. Also tests HashMap which is a non-renamed import.

struct TestStruct {
    pub field: String,
    pub count: u32,
}

Fields:

  ◦ field: String
    A public field

  ◦ count: u32
    Another public field

Associated Types

  ◦ pub const ASSOCIATED_CONST
    This is an associated constant for a struct

  ◦ pub fn new(field: String, count: u32) -> Self
    Create a new TestStruct

  ◦ pub fn get_field(&self) -> &str
    Get the field value

  ◦ pub fn increment_count(&mut self)
    Update the count

Trait Implementations

TestTrait<T = String>

std: From<T>, RefUnwindSafe, UnwindSafe, Unpin, Clone, UnsafeUnpin, Freeze, Sync, Debug, Send

  ◦ impl<T, U: From<T>> Into<U>

  ◦ impl<T: Clone> CloneToUninit

  ◦ impl<T: ?Sized> BorrowMut<T>

  ◦ impl<T: ?Sized> Borrow<T>

  ◦ impl<T: Clone> ToOwned
        type Owned = T

  ◦ impl<T: 'static + ?Sized> Any

  ◦ impl<T, U: Into<T>> TryFrom<U>
        type Error = Infallible

  ◦ impl<T, U: TryFrom<T>> TryInto<U>
        type Error = <U as TryFrom<T>>::Error