tower_redis_cell/
error.rs1use crate::rule::RequestBlockedDetails;
2#[cfg(feature = "deadpool")]
3use deadpool_redis::PoolError;
4use redis::RedisError;
5use redis_cell_rs::Key;
6use std::borrow::Cow;
7use std::fmt::Display;
8
9#[derive(Debug, Clone, Default)]
10#[non_exhaustive]
11pub struct ProvideRuleError<'a> {
12 pub detail: Option<Cow<'a, str>>,
13 pub key: Option<Key<'a>>,
14}
15
16impl Display for ProvideRuleError<'_> {
17 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
18 f.write_str("failed to provide rule")?;
19 if let Some(ref detail) = self.detail {
20 f.write_str(": ")?;
21 f.write_str(detail)?;
22 }
23 Ok(())
24 }
25}
26
27impl<'a> ProvideRuleError<'a> {
28 pub fn new<K, D>(key: K, detail: D) -> Self
29 where
30 K: Into<Key<'a>>,
31 D: Into<Cow<'a, str>>,
32 {
33 Self::default().key(key).detail(detail)
34 }
35
36 pub fn detail<D>(mut self, detail: D) -> Self
37 where
38 D: Into<Cow<'a, str>>,
39 {
40 self.detail = Some(detail.into());
41 self
42 }
43
44 pub fn key<K>(mut self, key: K) -> Self
45 where
46 K: Into<Key<'a>>,
47 {
48 self.key = Some(key.into());
49 self
50 }
51}
52
53impl From<String> for ProvideRuleError<'_> {
54 fn from(value: String) -> Self {
55 ProvideRuleError::default().detail(value)
56 }
57}
58
59impl<'a> From<&'a str> for ProvideRuleError<'a> {
60 fn from(value: &'a str) -> Self {
61 ProvideRuleError::default().detail(value)
62 }
63}
64
65#[derive(Debug, thiserror::Error)]
66#[non_exhaustive]
67pub enum Error<'a> {
68 #[error("rule: {0}")]
69 ProvideRule(ProvideRuleError<'a>),
70
71 #[error(transparent)]
72 Redis(#[from] RedisError),
73
74 #[cfg(feature = "deadpool")]
75 #[error(transparent)]
76 Deadpool(#[from] PoolError),
77
78 #[error("request blocked for key {} and can be retried after {} second(s)", .0.rule.key, .0.details.retry_after)]
79 RateLimit(RequestBlockedDetails<'a>),
80}