bomboni_request 0.3.0

Utilities for working with API requests. Part of Bomboni library.
Documentation 
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

use bomboni_proto::google::rpc::Code;
use thiserror::Error;

use crate::{error::GenericError, filter::error::FilterError, ordering::error::OrderingError};

/// Query processing errors.
#[derive(Error, Debug, Clone, PartialEq, Eq)]
pub enum QueryError {
    /// Filter error.
    #[error("filter error: {0}")]
    FilterError(FilterError),
    /// Filter is too long.
    #[error("filter is too long")]
    FilterTooLong,
    /// Filter schema mismatch.
    #[error("filter schema mismatch")]
    FilterSchemaMismatch,
    /// Ordering error.
    #[error("ordering error: {0}")]
    OrderingError(OrderingError),
    /// Ordering is too long.
    #[error("ordering is too long")]
    OrderingTooLong,
    /// Ordering schema mismatch.
    #[error("ordering schema mismatch")]
    OrderingSchemaMismatch,
    /// Query is too long.
    #[error("query is too long")]
    QueryTooLong,
    /// Page token is invalid.
    #[error("page token is invalid")]
    InvalidPageToken,
    /// Page token could not be built.
    #[error("page token could not be built")]
    PageTokenFailure,
    /// Page size specified is invalid.
    #[error("page size specified is invalid")]
    InvalidPageSize,
}

/// Result type for query operations.
pub type QueryResult<T> = Result<T, QueryError>;

impl QueryError {
    /// Gets the name of the field that caused the error.
    pub const fn get_violating_field_name(&self) -> &'static str {
        match self {
            Self::FilterError(_) | Self::FilterTooLong | Self::FilterSchemaMismatch => "filter",
            Self::OrderingError(_) | Self::OrderingTooLong | Self::OrderingSchemaMismatch => {
                "order_by"
            }
            Self::QueryTooLong => "query",
            Self::InvalidPageToken | Self::PageTokenFailure => "page_token",
            Self::InvalidPageSize => "page_size",
        }
    }
}

impl From<FilterError> for QueryError {
    fn from(err: FilterError) -> Self {
        Self::FilterError(err)
    }
}

impl From<OrderingError> for QueryError {
    fn from(err: OrderingError) -> Self {
        Self::OrderingError(err)
    }
}

impl GenericError for QueryError {
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }

    fn code(&self) -> Code {
        Code::InvalidArgument
    }
}