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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
mod context;
mod global;
mod keyword;
// -----------------------------------------------------------------------------
use crate::simple::{AutocompleteType, SearchIndex};
use std::cmp::Ord;
use std::hash::Hash;
// -----------------------------------------------------------------------------
impl<K: Hash + Ord> SearchIndex<K> {
// -------------------------------------------------------------------------
//
/// Returns matching autocompleted keywords for the provided search string.
/// This function will use the `AutocompleteType` setting stored in the
/// `SearchIndex`. Partial keywords must be an exact match. Results are
/// returned in lexographic order.
///
/// Autocompletion behaviour can be changed by setting the
/// [`AutocompleteType`] in the `SearchIndex`. See also:
/// [`SearchIndexBuilder`] and [`SearchIndex::new()`].
///
/// [`AutocompleteType`]: enum.AutocompleteType.html
/// [`SearchIndexBuilder`]: struct.SearchIndexBuilder.html
/// [`SearchIndex::new()`]: struct.SearchIndex.html#method.new
///
/// Basic usage:
///
/// ```rust
/// # use indicium::simple::{AutocompleteType, Indexable, SearchIndex, SearchType};
/// # use pretty_assertions::assert_eq;
/// #
/// # struct MyStruct {
/// # title: String,
/// # year: u16,
/// # body: String,
/// # }
/// #
/// # impl Indexable for MyStruct {
/// # fn strings(&self) -> Vec<String> {
/// # vec![
/// # self.title.clone(),
/// # self.year.to_string(),
/// # self.body.clone(),
/// # ]
/// # }
/// # }
/// #
/// # let my_vec = vec![
/// # MyStruct {
/// # title: "Harold Godwinson".to_string(),
/// # year: 1066,
/// # body: "Last crowned Anglo-Saxon king of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Edgar Ætheling".to_string(),
/// # year: 1066,
/// # body: "Last male member of the royal house of Cerdic of Wessex.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William the Conqueror".to_string(),
/// # year: 1066,
/// # body: "First Norman monarch of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William Rufus".to_string(),
/// # year: 1087,
/// # body: "Third son of William the Conqueror.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Henry Beauclerc".to_string(),
/// # year: 1100,
/// # body: "Fourth son of William the Conqueror.".to_string(),
/// # },
/// # ];
/// #
/// # let mut search_index: SearchIndex<usize> = SearchIndex::default();
/// #
/// # my_vec
/// # .iter()
/// # .enumerate()
/// # .for_each(|(index, element)|
/// # search_index.insert(&index, element)
/// # );
/// #
/// let autocomplete_options = search_index.autocomplete("Edgar last c");
/// assert_eq!(autocomplete_options, vec!["edgar last cerdic".to_string()]);
/// ```
#[tracing::instrument(level = "trace", name = "autocomplete", skip(self))]
pub fn autocomplete(&self, string: &str) -> Vec<String> {
let autocomplete_options: Vec<String> = match &self.autocomplete_type {
AutocompleteType::Context =>
self.autocomplete_context(&self.maximum_autocomplete_options, string),
AutocompleteType::Global =>
self.autocomplete_global(&self.maximum_autocomplete_options, string),
AutocompleteType::Keyword =>
self.autocomplete_keyword(&self.maximum_autocomplete_options, string)
.into_iter()
.map(|str| str.to_string())
.collect(),
}; // match
// For debug builds:
#[cfg(debug_assertions)]
tracing::debug!(
"{} autocomplete options for \"{}\".",
autocomplete_options.len(),
string,
); // debug!
autocomplete_options
} // fn
// -------------------------------------------------------------------------
//
/// This autocomplete method allows the caller to define an
/// `AutocompleteType` parameter, effectively overriding the index settings.
/// See [`AutocompleteType`] for more information on the different
/// autocomplete types.
///
/// Returns matching autocompleted keywords for the provided search string.
/// Partial keywords must be an exact match. Results are returned in
/// lexographic order.
///
/// [`AutocompleteType`]: enum.AutocompleteType.html
///
/// Basic usage:
///
/// ```rust
/// # use indicium::simple::{AutocompleteType, Indexable, SearchIndex, SearchType};
/// # use pretty_assertions::assert_eq;
/// #
/// # struct MyStruct {
/// # title: String,
/// # year: u16,
/// # body: String,
/// # }
/// #
/// # impl Indexable for MyStruct {
/// # fn strings(&self) -> Vec<String> {
/// # vec![
/// # self.title.clone(),
/// # self.year.to_string(),
/// # self.body.clone(),
/// # ]
/// # }
/// # }
/// #
/// # let my_vec = vec![
/// # MyStruct {
/// # title: "Harold Godwinson".to_string(),
/// # year: 1066,
/// # body: "Last crowned Anglo-Saxon king of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Edgar Ætheling".to_string(),
/// # year: 1066,
/// # body: "Last male member of the royal house of Cerdic of Wessex.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William the Conqueror".to_string(),
/// # year: 1066,
/// # body: "First Norman monarch of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William Rufus".to_string(),
/// # year: 1087,
/// # body: "Third son of William the Conqueror.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Henry Beauclerc".to_string(),
/// # year: 1100,
/// # body: "Fourth son of William the Conqueror.".to_string(),
/// # },
/// # ];
/// #
/// # let mut search_index: SearchIndex<usize> = SearchIndex::default();
/// #
/// # my_vec
/// # .iter()
/// # .enumerate()
/// # .for_each(|(index, element)|
/// # search_index.insert(&index, element)
/// # );
/// #
/// let autocomplete_options =
/// search_index.autocomplete_type(&AutocompleteType::Global, "1100 e");
///
/// assert_eq!(
/// autocomplete_options,
/// vec![
/// "1100 edgar".to_string(),
/// "1100 edgar ætheling".to_string(),
/// "1100 england".to_string()
/// ]
/// );
/// ```
#[tracing::instrument(level = "trace", name = "autocomplete", skip(self))]
pub fn autocomplete_type(
&self,
autocomplete_type: &AutocompleteType,
string: &str,
) -> Vec<String> {
let autocomplete_options: Vec<String> = match autocomplete_type {
AutocompleteType::Context =>
self.autocomplete_context(&self.maximum_autocomplete_options, string),
AutocompleteType::Global =>
self.autocomplete_global(&self.maximum_autocomplete_options, string),
AutocompleteType::Keyword =>
self.autocomplete_keyword(&self.maximum_autocomplete_options, string)
.into_iter()
.map(|str| str.to_string())
.collect(),
}; // match
// For debug builds:
#[cfg(debug_assertions)]
tracing::debug!(
"{} autocomplete options for \"{}\".",
autocomplete_options.len(),
string,
); // debug!
autocomplete_options
} // fn
// -------------------------------------------------------------------------
//
/// This autocomplete method allows the caller to define a
/// `AutocompleteType` and the maximum number of autocomplete options to be
/// returned. These parameters override the index settings. See
/// [`AutocompleteType`] for more information on the different search types.
///
/// Returns matching autocompleted keywords for the provided search string.
/// Partial keywords must be an exact match. Results are returned in
/// lexographic order.
///
/// [`AutocompleteType`]: enum.AutocompleteType.html
///
/// Basic usage:
///
/// ```rust
/// # use indicium::simple::{AutocompleteType, Indexable, SearchIndex, SearchType};
/// # use pretty_assertions::assert_eq;
/// #
/// # struct MyStruct {
/// # title: String,
/// # year: u16,
/// # body: String,
/// # }
/// #
/// # impl Indexable for MyStruct {
/// # fn strings(&self) -> Vec<String> {
/// # vec![
/// # self.title.clone(),
/// # self.year.to_string(),
/// # self.body.clone(),
/// # ]
/// # }
/// # }
/// #
/// # let my_vec = vec![
/// # MyStruct {
/// # title: "Harold Godwinson".to_string(),
/// # year: 1066,
/// # body: "Last crowned Anglo-Saxon king of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Edgar Ætheling".to_string(),
/// # year: 1066,
/// # body: "Last male member of the royal house of Cerdic of Wessex.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William the Conqueror".to_string(),
/// # year: 1066,
/// # body: "First Norman monarch of England.".to_string(),
/// # },
/// # MyStruct {
/// # title: "William Rufus".to_string(),
/// # year: 1087,
/// # body: "Third son of William the Conqueror.".to_string(),
/// # },
/// # MyStruct {
/// # title: "Henry Beauclerc".to_string(),
/// # year: 1100,
/// # body: "Fourth son of William the Conqueror.".to_string(),
/// # },
/// # ];
/// #
/// # let mut search_index: SearchIndex<usize> = SearchIndex::default();
/// #
/// # my_vec
/// # .iter()
/// # .enumerate()
/// # .for_each(|(index, element)|
/// # search_index.insert(&index, element)
/// # );
/// #
/// let autocomplete_options =
/// search_index.autocomplete_with(
/// &AutocompleteType::Global,
/// &5,
/// "1100 e",
/// );
///
/// assert_eq!(
/// autocomplete_options,
/// vec![
/// "1100 edgar".to_string(),
/// "1100 edgar ætheling".to_string(),
/// "1100 england".to_string()
/// ]
/// );
/// ```
#[tracing::instrument(level = "trace", name = "autocomplete", skip(self))]
pub fn autocomplete_with(
&self,
autocomplete_type: &AutocompleteType,
maximum_autocomplete_options: &usize,
string: &str,
) -> Vec<String> {
let autocomplete_options: Vec<String> = match autocomplete_type {
AutocompleteType::Context =>
self.autocomplete_context(maximum_autocomplete_options, string),
AutocompleteType::Global =>
self.autocomplete_global(maximum_autocomplete_options, string),
AutocompleteType::Keyword =>
self.autocomplete_keyword(maximum_autocomplete_options, string)
.into_iter()
.map(|str| str.to_string())
.collect(),
}; // match
// For debug builds:
#[cfg(debug_assertions)]
tracing::debug!(
"{} autocomplete options for \"{}\".",
autocomplete_options.len(),
string,
); // debug!
autocomplete_options
} // fn
} // impl