groxide 0.1.0

Query Rust crate documentation from the terminal
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

use crate::types::{IndexItem, ItemKind, SourceSpan};

/// Builds a test `IndexItem` with the given name, path, and kind.
///
/// All other fields are set to empty/default values.
pub(crate) fn make_item(name: &str, path: &str, kind: ItemKind) -> IndexItem {
    IndexItem {
        path: path.to_string(),
        name: name.to_string(),
        kind,
        signature: String::new(),
        docs: String::new(),
        summary: String::new(),
        span: make_source_span(),
        children: Vec::new(),
        is_public: true,
        has_body: false,
        feature_gate: None,
        reexport_source: None,
    }
}

/// Builds a test `IndexItem` with all text fields populated.
pub(crate) fn make_item_full(
    name: &str,
    path: &str,
    kind: ItemKind,
    signature: &str,
    docs: &str,
    summary: &str,
) -> IndexItem {
    IndexItem {
        path: path.to_string(),
        name: name.to_string(),
        kind,
        signature: signature.to_string(),
        docs: docs.to_string(),
        summary: summary.to_string(),
        span: make_source_span(),
        children: Vec::new(),
        is_public: true,
        has_body: false,
        feature_gate: None,
        reexport_source: None,
    }
}

/// Creates an empty `SourceSpan` for test use.
pub(crate) fn make_source_span() -> SourceSpan {
    SourceSpan {
        file: String::new(),
        line_start: 0,
        line_end: 0,
    }
}

/// Builds a test `IndexItem` representing a re-export stub
/// (`pub use source::Item as Item`). Sets `reexport_source`, sets a
/// matching `pub use` signature, and leaves `children` empty so the item
/// passes `query::is_reexport_stub`.
pub(crate) fn make_reexport_stub(
    name: &str,
    path: &str,
    kind: ItemKind,
    source: &str,
) -> IndexItem {
    let mut item = make_item(name, path, kind);
    item.reexport_source = Some(source.to_string());
    item.signature = format!("pub use {source} as {name}");
    item
}