open_net/libs/retry/src/
schedule.rs1use super::{Backoff, Jitter, RetryConfigError};
2use std::time::Duration;
3
4#[derive(Clone, Debug, PartialEq)]
6pub enum RetrySetting<P> {
7 Inherit,
9 Disabled,
11 Policy(P),
13}
14
15impl<P> Default for RetrySetting<P> {
16 fn default() -> Self {
17 Self::Inherit
18 }
19}
20
21impl<P: Clone> RetrySetting<P> {
22 pub fn resolve(&self, default: &P, disabled: P) -> P {
24 match self {
25 Self::Inherit => default.clone(),
26 Self::Disabled => disabled,
27 Self::Policy(policy) => policy.clone(),
28 }
29 }
30}
31
32#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
34pub enum RetryDecision {
35 #[default]
37 Default,
38 Retry,
40 Stop,
42}
43
44#[derive(Clone, Debug, PartialEq)]
49pub struct RetrySchedule {
50 max_attempts: u32,
51 backoff: Backoff,
52 jitter: Jitter,
53}
54
55impl RetrySchedule {
56 pub fn builder() -> RetryScheduleBuilder {
58 RetryScheduleBuilder::default()
59 }
60
61 pub fn no_retry() -> Self {
63 Self {
64 max_attempts: 1,
65 backoff: Backoff::None,
66 jitter: Jitter::None,
67 }
68 }
69
70 pub fn max_attempts(&self) -> u32 {
72 self.max_attempts
73 }
74
75 pub fn backoff(&self) -> &Backoff {
77 &self.backoff
78 }
79
80 pub fn jitter(&self) -> Jitter {
82 self.jitter
83 }
84
85 pub fn delay_for(&self, retry_ordinal: u32) -> Result<Duration, RetryConfigError> {
89 if retry_ordinal == 0 || retry_ordinal >= self.max_attempts {
90 return Err(RetryConfigError::new(
91 "retry_ordinal",
92 "must be between one and max_attempts - 1",
93 ));
94 }
95 self.backoff.delay_for_validated(retry_ordinal)
96 }
97
98 pub(crate) fn sampled_delay(
99 &self,
100 retry_ordinal: u32,
101 unit: f64,
102 ) -> Result<Duration, RetryConfigError> {
103 self.jitter
104 .apply(self.delay_for(retry_ordinal)?, unit, &self.backoff)
105 }
106}
107
108impl Default for RetrySchedule {
109 fn default() -> Self {
110 Self::no_retry()
111 }
112}
113
114#[derive(Clone, Debug)]
116pub struct RetryScheduleBuilder {
117 max_attempts: u32,
118 backoff: Backoff,
119 jitter: Jitter,
120}
121
122impl Default for RetryScheduleBuilder {
123 fn default() -> Self {
124 Self {
125 max_attempts: 1,
126 backoff: Backoff::None,
127 jitter: Jitter::None,
128 }
129 }
130}
131
132impl RetryScheduleBuilder {
133 pub fn max_attempts(mut self, count: u32) -> Self {
135 self.max_attempts = count;
136 self
137 }
138
139 pub fn backoff(mut self, backoff: Backoff) -> Self {
141 self.backoff = backoff;
142 self
143 }
144
145 pub fn jitter(mut self, jitter: Jitter) -> Self {
147 self.jitter = jitter;
148 self
149 }
150
151 pub fn build(self) -> Result<RetrySchedule, RetryConfigError> {
153 if self.max_attempts == 0 {
154 return Err(RetryConfigError::new(
155 "max_attempts",
156 "must be at least one",
157 ));
158 }
159 self.backoff.validate(self.max_attempts)?;
160 self.jitter.validate(&self.backoff)?;
161 Ok(RetrySchedule {
162 max_attempts: self.max_attempts,
163 backoff: self.backoff,
164 jitter: self.jitter,
165 })
166 }
167}