docsrs_cli/crates_io/
types.rs1use serde::{Deserialize, Serialize};
4use url::Url;
5
6use super::urls::clamp_search_pagination;
7use crate::cli::SortKind;
8use crate::config::MAX_PER_PAGE;
9use crate::domain::SearchQuery;
10
11#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
13pub struct CrateSearchHit {
14 pub name: String,
16 pub description: String,
18 pub downloads: u64,
20 pub version: String,
22 #[serde(skip_serializing_if = "Option::is_none")]
24 pub documentation: Option<String>,
25 #[serde(skip_serializing_if = "Option::is_none")]
27 pub max_version: Option<String>,
28 #[serde(skip_serializing_if = "Option::is_none")]
30 pub max_stable_version: Option<String>,
31 #[serde(skip_serializing_if = "Option::is_none")]
33 pub default_version: Option<String>,
34 #[serde(skip_serializing_if = "Option::is_none")]
36 pub recent_downloads: Option<u64>,
37 #[serde(skip_serializing_if = "Option::is_none")]
39 pub exact_match: Option<bool>,
40 #[serde(skip_serializing_if = "Option::is_none")]
42 pub yanked: Option<bool>,
43 #[serde(skip_serializing_if = "Option::is_none")]
45 pub repository: Option<String>,
46 #[serde(skip_serializing_if = "Option::is_none")]
48 pub homepage: Option<String>,
49}
50
51#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
53pub struct SearchMeta {
54 pub total: u64,
56 #[serde(skip_serializing_if = "Option::is_none")]
58 pub next_page: Option<String>,
59 #[serde(skip_serializing_if = "Option::is_none")]
61 pub prev_page: Option<String>,
62}
63
64#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
66pub struct SearchCratesData {
67 pub query: String,
69 pub page: u32,
71 pub per_page: u32,
73 pub sort: String,
75 pub hits: Vec<CrateSearchHit>,
77 pub meta: SearchMeta,
79 pub cache_hit: bool,
81 pub truncated: bool,
83}
84
85#[derive(Debug, Clone, PartialEq, Eq)]
88pub struct SearchEcho {
89 pub query: String,
91 pub page: u32,
93 pub per_page: u32,
95 pub sort: String,
97}
98
99impl SearchEcho {
100 pub fn from_cli(query: &SearchQuery, page: u32, per_page: u32, sort: SortKind) -> Self {
102 let (per_page, page) = clamp_search_pagination(per_page, page);
103 Self {
104 query: query.as_str().to_string(),
105 page,
106 per_page,
107 sort: sort.as_api_str().to_string(),
108 }
109 }
110}
111
112pub fn echo_params_from_url(url: &Url, fallback: &SearchEcho) -> SearchEcho {
117 let mut query = fallback.query.clone();
118 let mut page = fallback.page;
119 let mut per_page = fallback.per_page;
120 let mut sort = fallback.sort.clone();
121 for (k, v) in url.query_pairs() {
122 match k.as_ref() {
123 "q" => query = v.into_owned(),
124 "page" => {
125 if let Ok(n) = v.parse::<u32>() {
126 page = n.max(1);
127 }
128 }
129 "per_page" => {
130 if let Ok(n) = v.parse::<u32>() {
131 per_page = n.clamp(1, MAX_PER_PAGE);
132 }
133 }
134 "sort" => sort = v.into_owned(),
135 _ => {}
136 }
137 }
138 let (per_page, page) = clamp_search_pagination(per_page, page);
139 SearchEcho {
140 query,
141 page,
142 per_page,
143 sort,
144 }
145}