wiki-tui 0.5.0

A simple and easy to use Wikipedia Text User Interface
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

/// A struct representing a single search result. It's generated by the SearchBuilder and should
/// not be created directly. Instead, use the one SearchBuilder creates for you.
/// It's important to know that only some values are in every search result and the rest of them are
/// optional.
#[derive(Clone)]
pub struct SearchResult {
    /// The title of the search result, usually the title of the article it represents
    title: String,
    /// The namespace of the article the search result represents
    namespace: usize,
    /// The page id of the article the search result represents
    page_id: i32,
    /// The size of the article
    size: Option<i32>,

    /// The word count of the article
    wordcount: Option<i32>,
    /// The date and time the article was last modified
    timestamp: Option<String>,

    /// A small preview of the article
    snippet: Option<String>,
    /// A title snippet of the article
    title_snippet: Option<String>,
    /// The snippet for the category
    category_snippet: Option<String>,

    /// The title of the redirect
    redirect_title: Option<String>,
    /// The snippet of the redirect
    redirect_snippet: Option<String>,

    /// The title of the section
    section_title: Option<String>,
    /// The snippet of the section
    section_snippet: Option<String>,

    /// If it's a file match
    file_match: Option<bool>,
}

/// A helper macro for generating getter functions in the SearchResult struct
macro_rules! build_getter {
    ($(#[$meta :meta])* $value: ident, $return_type: ty) => {
        $(#[$meta])*
        pub fn $value(&self) -> Option<$return_type> {
            match &self.$value {
                Some(ref value) => Some(value),
                None => None,
            }
        }
    };
}

impl SearchResult {
    /// Creates a new struct with the given metadata. This function should not be used directly
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        title: String,
        namespace: usize,
        page_id: i32,
        size: Option<i32>,
        wordcount: Option<i32>,
        timestamp: Option<String>,
        snippet: Option<String>,
        title_snippet: Option<String>,
        category_snippet: Option<String>,
        redirect_title: Option<String>,
        redirect_snippet: Option<String>,
        section_title: Option<String>,
        section_snippet: Option<String>,
        is_file_match: Option<bool>,
    ) -> Self {
        Self {
            title,
            namespace,
            page_id,
            size,
            wordcount,
            timestamp,
            snippet,
            title_snippet,
            category_snippet,
            redirect_title,
            redirect_snippet,
            section_title,
            section_snippet,
            file_match: is_file_match,
        }
    }

    /// The title of the search result, usually the title of the article it represents
    pub fn title(&self) -> &str {
        &self.title
    }

    /// The namespace of the article the search result represents
    pub fn namespace(&self) -> &usize {
        &self.namespace
    }

    /// The page id of the article the search result represents
    pub fn page_id(&self) -> &i32 {
        &self.page_id
    }

    build_getter!(
        /// The size of the article
        size,
        &i32
    );
    build_getter!(
        /// The word count of the article
        wordcount,
        &i32
    );
    build_getter!(
        /// The date and time the article was last modified
        timestamp,
        &str
    );

    build_getter!(
        /// A small preview of the article
        snippet,
        &str
    );
    build_getter!(
        /// A title snippet for the article
        title_snippet,
        &str
    );
    build_getter!(
        /// The snippet for the category
        category_snippet,
        &str
    );

    build_getter!(
        /// The title of the redirect
        redirect_title,
        &str
    );
    build_getter!(
        /// The snippet of the redirect
        redirect_snippet,
        &str
    );

    build_getter!(
        /// The title of the section
        section_title,
        &str
    );
    build_getter!(
        /// The snippet of the section
        section_snippet,
        &str
    );

    /// If it's a file match
    pub fn is_file_match(&self) -> Option<&bool> {
        self.file_match.as_ref()
    }
}