simplify the error handling of the sort syntax for meilisearch

This commit is contained in:
Tamo
2021-09-27 19:07:22 +02:00
parent 4c09f6838f
commit c7cb816ae1
3 changed files with 67 additions and 15 deletions

View File

@ -6,7 +6,7 @@ use std::str::FromStr;
use serde::{Deserialize, Serialize};
use crate::error::is_reserved_keyword;
use crate::CriterionError;
use crate::{CriterionError, Error, UserError};
/// This error type is never supposed to be shown to the end user.
/// You must always cast it to a sort error or a criterion error.
@ -139,6 +139,68 @@ impl FromStr for AscDesc {
}
}
#[derive(Debug)]
pub enum SortError {
InvalidName { name: String },
ReservedName { name: String },
ReservedNameForSettings { name: String },
ReservedNameForFilter { name: String },
}
impl From<AscDescError> for SortError {
fn from(error: AscDescError) -> Self {
match error {
AscDescError::InvalidSyntax { name } => SortError::InvalidName { name },
AscDescError::ReservedKeyword { name } if &name == "_geo" => {
SortError::ReservedNameForSettings { name: "_geoPoint".to_string() }
}
AscDescError::ReservedKeyword { name } if name.starts_with("_geoRadius") => {
SortError::ReservedNameForFilter { name: "_geoRadius".to_string() }
}
AscDescError::ReservedKeyword { name } => SortError::ReservedName { name },
}
}
}
impl fmt::Display for SortError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Self::InvalidName { name } => {
write!(f, "invalid syntax for the sort parameter {}", name)
}
Self::ReservedName { name } => {
write!(
f,
"{} is a reserved keyword and thus can't be used as a sort expression",
name
)
}
Self::ReservedNameForSettings { name } => {
write!(
f,
"{} is a reserved keyword and thus can't be used as a sort expression. \
{} can only be used in the settings",
name, name
)
}
Self::ReservedNameForFilter { name } => {
write!(
f,
"{} is a reserved keyword and thus can't be used as a sort expression. \
{} can only be used for filtering at search time",
name, name
)
}
}
}
}
impl From<SortError> for Error {
fn from(error: SortError) -> Self {
Self::UserError(UserError::SortError(error))
}
}
#[cfg(test)]
mod tests {
use big_s::S;