qubit_http/options/
http_retry_method_policy.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026 Haixing Hu.
4 *
5 *    SPDX-License-Identifier: Apache-2.0
6 *
7 *    Licensed under the Apache License, Version 2.0.
8 *
9 ******************************************************************************/
10
11use std::str::FromStr;
12
13use http::Method;
14use parse_display::FromStr as DeriveFromStr;
15use serde::{
16    Deserialize,
17    Serialize,
18};
19
20use super::HttpConfigError;
21
22/// HTTP method policy used to decide whether a request can be retried.
23#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, DeriveFromStr)]
24#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
25pub enum HttpRetryMethodPolicy {
26    /// Retry only HTTP methods that are safe to replay by default.
27    #[default]
28    #[display("IDEMPOTENT_ONLY")]
29    #[from_str(regex = "(?i)IDEMPOTENT_ONLY|IDEMPOTENT")]
30    IdempotentOnly,
31    /// Retry all HTTP methods, including `POST` and `PATCH`.
32    #[display("ALL_METHODS")]
33    #[from_str(regex = "(?i)ALL_METHODS|ALL")]
34    AllMethods,
35    /// Disable method-level retry eligibility.
36    #[display("NONE")]
37    #[from_str(regex = "(?i)NONE|DISABLED")]
38    None,
39}
40
41impl HttpRetryMethodPolicy {
42    pub(super) fn from_config_value(value: &str) -> Result<Self, HttpConfigError> {
43        Self::from_str(value.trim()).map_err(|_| {
44            HttpConfigError::invalid_value("method_policy", format!("Unsupported retry method policy: {value}"))
45        })
46    }
47
48    /// Returns whether the retry executor permits replaying `method`.
49    ///
50    /// # Parameters
51    /// - `method`: HTTP method to evaluate.
52    ///
53    /// # Returns
54    /// `true` when automatic retry may replay the method.
55    pub fn allows_method(&self, method: &Method) -> bool {
56        match self {
57            Self::IdempotentOnly => matches!(
58                *method,
59                Method::GET | Method::HEAD | Method::PUT | Method::DELETE | Method::OPTIONS | Method::TRACE
60            ),
61            Self::AllMethods => true,
62            Self::None => false,
63        }
64    }
65}
qubit_http/options/http_retry_method_policy.rs

qubit_http/options/
http_retry_method_policy.rs
