use core::fmt;
use core::marker::PhantomData;
use super::common::{RetryOp, execute_sync_loop};
use crate::compat::Duration;
use crate::error::RetryError;
#[cfg(feature = "alloc")]
use crate::policy::HookChain;
use crate::policy::time::ElapsedTracker;
use crate::policy::{
AttemptHook, BeforeAttemptHook, ExecutionHooks, ExitHook, PolicyHandle, RetryPolicy,
};
use crate::predicate::Predicate;
use crate::state::{AttemptState, ExitState, RetryState};
use crate::stats::RetryStats;
use crate::stop::Stop;
use crate::wait::Wait;
#[doc(hidden)]
pub struct NoSyncSleep;
#[doc(hidden)]
pub trait SyncSleep {
fn sleep(&mut self, dur: Duration);
}
impl<F> SyncSleep for F
where
F: FnMut(Duration),
{
fn sleep(&mut self, dur: Duration) {
(self)(dur);
}
}
#[cfg(feature = "std")]
impl SyncSleep for NoSyncSleep {
fn sleep(&mut self, dur: Duration) {
std::thread::sleep(dur);
}
}
#[allow(clippy::type_complexity)]
pub struct SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E> {
policy: Policy,
hooks: ExecutionHooks<BA, AA, OX>,
op: F,
sleeper: SleepFn,
elapsed_tracker: ElapsedTracker,
timeout: Option<Duration>,
_marker: PhantomData<fn() -> (T, E)>,
}
pub type SyncRetry<'policy, S, W, P, BA, AA, OX, F, SleepFn, T, E> =
SyncRetryExec<&'policy RetryPolicy<S, W, P>, BA, AA, OX, F, SleepFn, T, E>;
#[allow(clippy::type_complexity)]
pub struct SyncRetryExecWithStats<Policy, BA, AA, OX, F, SleepFn, T, E> {
inner: SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E>,
}
pub type SyncRetryWithStats<'policy, S, W, P, BA, AA, OX, F, SleepFn, T, E> =
SyncRetryExecWithStats<&'policy RetryPolicy<S, W, P>, BA, AA, OX, F, SleepFn, T, E>;
impl<Policy, BA, AA, OX, F, SleepFn, T, E> fmt::Debug
for SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E>
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SyncRetryExec").finish_non_exhaustive()
}
}
impl<Policy, BA, AA, OX, F, SleepFn, T, E> fmt::Debug
for SyncRetryExecWithStats<Policy, BA, AA, OX, F, SleepFn, T, E>
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SyncRetryExecWithStats")
.finish_non_exhaustive()
}
}
#[cfg(not(feature = "std"))]
#[doc(hidden)]
#[allow(dead_code)]
fn _sync_call_requires_sleep_in_no_std() {}
impl<Policy, BA, AA, OX, F, SleepFn, T, E> SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E> {
pub(crate) fn new(
policy: Policy,
hooks: ExecutionHooks<BA, AA, OX>,
op: F,
sleeper: SleepFn,
elapsed_tracker: ElapsedTracker,
) -> Self {
Self {
policy,
hooks,
op,
sleeper,
elapsed_tracker,
timeout: None,
_marker: PhantomData,
}
}
fn map_hooks<NewBA, NewAA, NewOX>(
self,
map: impl FnOnce(ExecutionHooks<BA, AA, OX>) -> ExecutionHooks<NewBA, NewAA, NewOX>,
) -> SyncRetryExec<Policy, NewBA, NewAA, NewOX, F, SleepFn, T, E> {
SyncRetryExec {
policy: self.policy,
hooks: map(self.hooks),
op: self.op,
sleeper: self.sleeper,
elapsed_tracker: self.elapsed_tracker,
timeout: self.timeout,
_marker: PhantomData,
}
}
pub(crate) fn map_policy<NewPolicy>(
self,
map: impl FnOnce(Policy) -> NewPolicy,
) -> SyncRetryExec<NewPolicy, BA, AA, OX, F, SleepFn, T, E> {
SyncRetryExec {
policy: map(self.policy),
hooks: self.hooks,
op: self.op,
sleeper: self.sleeper,
elapsed_tracker: self.elapsed_tracker,
timeout: self.timeout,
_marker: PhantomData,
}
}
#[must_use]
pub fn elapsed_clock(mut self, clock: fn() -> Duration) -> Self {
self.elapsed_tracker = ElapsedTracker::new(Some(clock));
self
}
#[cfg(feature = "alloc")]
#[must_use]
pub fn elapsed_clock_fn(mut self, clock: impl Fn() -> Duration + 'static) -> Self {
self.elapsed_tracker = ElapsedTracker::new_boxed(crate::compat::Box::new(clock));
self
}
#[must_use]
pub fn timeout(mut self, dur: Duration) -> Self {
self.timeout = Some(dur);
self
}
fn execute<const COLLECT_STATS: bool>(
mut self,
) -> (Result<T, RetryError<T, E>>, Option<RetryStats>)
where
Policy: PolicyHandle,
Policy::Stop: Stop,
Policy::Wait: Wait,
Policy::Predicate: Predicate<T, E>,
BA: BeforeAttemptHook,
AA: AttemptHook<T, E>,
OX: ExitHook<T, E>,
F: RetryOp<T, E>,
SleepFn: SyncSleep,
{
let policy = self.policy.policy_ref();
execute_sync_loop::<
Policy::Stop,
Policy::Wait,
Policy::Predicate,
BA,
AA,
OX,
F,
SleepFn,
T,
E,
COLLECT_STATS,
>(
policy,
&mut self.hooks,
&mut self.op,
&mut self.sleeper,
&self.elapsed_tracker,
self.timeout,
)
}
#[must_use]
pub fn with_stats(self) -> SyncRetryExecWithStats<Policy, BA, AA, OX, F, SleepFn, T, E> {
SyncRetryExecWithStats { inner: self }
}
#[allow(private_bounds)]
pub fn call(self) -> Result<T, RetryError<T, E>>
where
Policy: PolicyHandle,
Policy::Stop: Stop,
Policy::Wait: Wait,
Policy::Predicate: Predicate<T, E>,
BA: BeforeAttemptHook,
AA: AttemptHook<T, E>,
OX: ExitHook<T, E>,
F: RetryOp<T, E>,
SleepFn: SyncSleep,
{
self.execute::<false>().0
}
}
impl<Policy, BA, AA, OX, F, T, E> SyncRetryExec<Policy, BA, AA, OX, F, NoSyncSleep, T, E> {
#[must_use]
pub fn sleep<SleepFn>(
self,
sleeper: SleepFn,
) -> SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E> {
SyncRetryExec {
policy: self.policy,
hooks: self.hooks,
op: self.op,
sleeper,
elapsed_tracker: self.elapsed_tracker,
timeout: self.timeout,
_marker: PhantomData,
}
}
}
impl<Policy, BA, AA, OX, F, SleepFn, T, E>
SyncRetryExecWithStats<Policy, BA, AA, OX, F, SleepFn, T, E>
{
#[allow(private_bounds)]
pub fn call(self) -> (Result<T, RetryError<T, E>>, RetryStats)
where
Policy: PolicyHandle,
Policy::Stop: Stop,
Policy::Wait: Wait,
Policy::Predicate: Predicate<T, E>,
BA: BeforeAttemptHook,
AA: AttemptHook<T, E>,
OX: ExitHook<T, E>,
F: RetryOp<T, E>,
SleepFn: SyncSleep,
{
let (result, stats) = self.inner.execute::<true>();
(result, stats.expect("sync retry completed without stats"))
}
}
impl_alloc_hook_chain! {
impl[Policy, BA, AA, OX, F, SleepFn, T, E]
SyncRetryExec<Policy, BA, AA, OX, F, SleepFn, T, E> =>
before_attempt -> { SyncRetryExec<Policy, HookChain<BA, Hook>, AA, OX, F, SleepFn, T, E> },
after_attempt -> { SyncRetryExec<Policy, BA, HookChain<AA, Hook>, OX, F, SleepFn, T, E> },
on_exit -> { SyncRetryExec<Policy, BA, AA, HookChain<OX, Hook>, F, SleepFn, T, E> },
}
#[cfg(not(feature = "alloc"))]
impl<Policy, AA, OX, F, SleepFn, T, E> SyncRetryExec<Policy, (), AA, OX, F, SleepFn, T, E> {
#[must_use]
pub fn before_attempt<Hook>(
self,
hook: Hook,
) -> SyncRetryExec<Policy, Hook, AA, OX, F, SleepFn, T, E>
where
Hook: FnMut(&RetryState),
{
self.map_hooks(|hooks| hooks.set_before_attempt(hook))
}
}
#[cfg(not(feature = "alloc"))]
impl<Policy, BA, OX, F, SleepFn, T, E> SyncRetryExec<Policy, BA, (), OX, F, SleepFn, T, E> {
#[must_use]
pub fn after_attempt<Hook>(
self,
hook: Hook,
) -> SyncRetryExec<Policy, BA, Hook, OX, F, SleepFn, T, E>
where
Hook: for<'a> FnMut(&AttemptState<'a, T, E>),
{
self.map_hooks(|hooks| hooks.set_after_attempt(hook))
}
}
#[cfg(not(feature = "alloc"))]
impl<Policy, BA, AA, F, SleepFn, T, E> SyncRetryExec<Policy, BA, AA, (), F, SleepFn, T, E> {
#[must_use]
pub fn on_exit<Hook>(self, hook: Hook) -> SyncRetryExec<Policy, BA, AA, Hook, F, SleepFn, T, E>
where
Hook: for<'a> FnMut(&ExitState<'a, T, E>),
{
self.map_hooks(|hooks| hooks.set_on_exit(hook))
}
}
impl<S, W, P> RetryPolicy<S, W, P>
where
S: Stop,
W: Wait,
{
#[must_use]
pub fn retry<T, E, F>(&self, op: F) -> SyncRetry<'_, S, W, P, (), (), (), F, NoSyncSleep, T, E>
where
F: FnMut(RetryState) -> Result<T, E>,
{
SyncRetryExec::new(
self,
ExecutionHooks::new(),
op,
NoSyncSleep,
ElapsedTracker::new(None),
)
}
}