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
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
142
143
144

use crate::renderer::HistoryEntry;
use crate::request::Request;
use crate::styled_string::Document;
use std::fmt::Display;

mod get;
pub(crate) mod list;
pub(crate) mod search;

#[derive(clap::Subcommand, Debug)]
pub(crate) enum Commands {
    /// Show documentation for an item
    Get {
        /// Path to the item (e.g., "std::vec::Vec" or "serde::Serialize")
        path: String,

        /// Show source code
        #[arg(short, long)]
        source: bool,

        /// Recursively show nested items
        #[arg(short, long)]
        recursive: bool,
    },

    /// Search for items by name or documentation
    Search {
        /// Search query
        query: String,

        /// Crate to search
        #[arg(short, long = "crate")]
        crate_: Option<String>,

        /// Maximum number of results
        #[arg(short, long, default_value = "10")]
        limit: usize,
    },

    /// List available crates
    List,
}

impl Commands {
    pub fn get(path: impl Display) -> Self {
        Self::Get {
            path: path.to_string(),
            source: false,
            recursive: false,
        }
    }

    pub fn search(query: impl Display) -> Self {
        Self::Search {
            query: query.to_string(),
            limit: 10,
            crate_: None,
        }
    }

    pub fn list() -> Self {
        Self::List
    }

    pub fn with_source(self) -> Self {
        match self {
            Self::Get {
                path, recursive, ..
            } => Self::Get {
                path,
                source: true,
                recursive,
            },
            other => other,
        }
    }

    pub fn in_crate(self, crate_: impl Display) -> Self {
        match self {
            Self::Search { query, limit, .. } => Self::Search {
                query,
                limit,
                crate_: Some(crate_.to_string()),
            },
            other => other,
        }
    }

    pub fn recursive(self) -> Self {
        match self {
            Self::Get { path, source, .. } => Self::Get {
                path,
                source,
                recursive: true,
            },
            other => other,
        }
    }

    pub fn with_limit(self, limit: usize) -> Self {
        match self {
            Self::Search { query, crate_, .. } => Self::Search {
                query,
                limit,
                crate_,
            },
            other => other,
        }
    }

    pub fn execute<'a>(
        self,
        request: &'a Request,
    ) -> (Document<'a>, bool, Option<HistoryEntry<'a>>) {
        match self {
            Commands::Get {
                path,
                source,
                recursive,
            } => {
                let (doc, is_error, item_ref) = get::execute(request, &path, source, recursive);
                let history_entry = item_ref.map(HistoryEntry::Item);
                (doc, is_error, history_entry)
            }
            Commands::Search {
                query,
                limit,
                crate_,
            } => {
                let (doc, is_error) = search::execute(request, &query, limit, crate_.as_deref());
                let history_entry = Some(HistoryEntry::Search {
                    query,
                    crate_name: crate_,
                });
                (doc, is_error, history_entry)
            }
            Commands::List => {
                let (doc, is_error, default_crate) = list::execute(request);
                let history_entry = Some(HistoryEntry::List { default_crate });
                (doc, is_error, history_entry)
            }
        }
    }
}