Skip to main content

SideEffectGuard

Struct SideEffectGuard 

Source
pub struct SideEffectGuard { /* private fields */ }
Expand description

Guard that tracks whether side effects should be executed.

During normal indexing, side effects (webhooks, external API calls) are executed. During replay after a reorg, side effects are skipped because they were already executed during the original processing.

§Example

use chainindex_core::idempotency::{ReplayContext, SideEffectGuard};

let ctx = ReplayContext::normal();
let guard = SideEffectGuard::new(&ctx);
assert!(guard.should_execute()); // normal mode: execute side effects

let replay_ctx = ReplayContext::replay(100, None);
let replay_guard = SideEffectGuard::new(&replay_ctx);
assert!(!replay_guard.should_execute()); // replay mode: skip side effects

Implementations§

Source§

impl SideEffectGuard

Source

pub fn new(replay_ctx: &ReplayContext) -> Self

Create a new guard based on the replay context.

Side effects are skipped when replay_ctx.is_replay is true.

Source

pub fn should_execute(&self) -> bool

Returns true if side effects should be executed (not in replay mode).

Source

pub async fn execute<F, Fut, T>(&self, f: F) -> Option<T>
where F: FnOnce() -> Fut, Fut: Future<Output = T>,

Execute a side effect only if not in replay mode.

Returns Some(result) if the side effect was executed, or None if it was skipped (replay mode).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more