98 lines
3.1 KiB
Rust
98 lines
3.1 KiB
Rust
use std::fmt;
|
|
use std::str::FromStr;
|
|
|
|
use once_cell::sync::Lazy;
|
|
use regex::Regex;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::error::{Error, UserError};
|
|
|
|
static ASC_DESC_REGEX: Lazy<Regex> =
|
|
Lazy::new(|| Regex::new(r#"(asc|desc)\(([\w_-]+)\)"#).unwrap());
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
|
|
pub enum Criterion {
|
|
/// Sorted by decreasing number of matched query terms.
|
|
/// Query words at the front of an attribute is considered better than if it was at the back.
|
|
Words,
|
|
/// Sorted by increasing number of typos.
|
|
Typo,
|
|
/// Sorted by increasing distance between matched query terms.
|
|
Proximity,
|
|
/// Documents with quey words contained in more important
|
|
/// attributes are considred better.
|
|
Attribute,
|
|
/// Sorted by the similarity of the matched words with the query words.
|
|
Exactness,
|
|
/// Sorted by the increasing value of the field specified.
|
|
Asc(String),
|
|
/// Sorted by the decreasing value of the field specified.
|
|
Desc(String),
|
|
}
|
|
|
|
impl Criterion {
|
|
/// Returns the field name parameter of this criterion.
|
|
pub fn field_name(&self) -> Option<&str> {
|
|
match self {
|
|
Criterion::Asc(name) | Criterion::Desc(name) => Some(name),
|
|
_otherwise => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl FromStr for Criterion {
|
|
type Err = Error;
|
|
|
|
fn from_str(txt: &str) -> Result<Criterion, Self::Err> {
|
|
match txt {
|
|
"words" => Ok(Criterion::Words),
|
|
"typo" => Ok(Criterion::Typo),
|
|
"proximity" => Ok(Criterion::Proximity),
|
|
"attribute" => Ok(Criterion::Attribute),
|
|
"exactness" => Ok(Criterion::Exactness),
|
|
text => {
|
|
let caps = ASC_DESC_REGEX
|
|
.captures(text)
|
|
.ok_or_else(|| UserError::InvalidCriterionName { name: text.to_string() })?;
|
|
let order = caps.get(1).unwrap().as_str();
|
|
let field_name = caps.get(2).unwrap().as_str();
|
|
match order {
|
|
"asc" => Ok(Criterion::Asc(field_name.to_string())),
|
|
"desc" => Ok(Criterion::Desc(field_name.to_string())),
|
|
text => {
|
|
return Err(
|
|
UserError::InvalidCriterionName { name: text.to_string() }.into()
|
|
)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn default_criteria() -> Vec<Criterion> {
|
|
vec![
|
|
Criterion::Words,
|
|
Criterion::Typo,
|
|
Criterion::Proximity,
|
|
Criterion::Attribute,
|
|
Criterion::Exactness,
|
|
]
|
|
}
|
|
|
|
impl fmt::Display for Criterion {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
use Criterion::*;
|
|
|
|
match self {
|
|
Words => f.write_str("words"),
|
|
Typo => f.write_str("typo"),
|
|
Proximity => f.write_str("proximity"),
|
|
Attribute => f.write_str("attribute"),
|
|
Exactness => f.write_str("exactness"),
|
|
Asc(attr) => write!(f, "asc({})", attr),
|
|
Desc(attr) => write!(f, "desc({})", attr),
|
|
}
|
|
}
|
|
}
|