Skip to main content

BookRecovery

Struct BookRecovery 

Source
pub struct BookRecovery<E> {
    pub cancellation: CancellationToken,
    pub outcome: Sender<BookRecoveryOutcome<E>>,
    pub gate: SnapshotGate,
}
Expand description

One recovery episode, retained across reconnects until a snapshot or terminal failure.

Fields§

§cancellation: CancellationToken§outcome: Sender<BookRecoveryOutcome<E>>§gate: SnapshotGate

Implementations§

Source§

impl<E: Clone> BookRecovery<E>

Source

pub fn begin_replacement(&self) -> bool

Closes snapshot acceptance, returning false if this episode has already ended.

Source

pub fn is_accepted(&self) -> bool

Returns whether the adapter has accepted a snapshot for this episode.

Source

pub fn accept(&self) -> bool

Returns true when the gate permits accepting a snapshot for this episode.

Source§

impl<E: Clone + Error> BookRecovery<E>

Source

pub async fn run<F, Fut>( &self, snapshot_timeout: Duration, replace: F, should_retry: impl Fn(&E) -> bool, create_error: impl Fn(String) -> E, timeout_error: impl Fn() -> E, ) -> Result<(), E>
where F: Fn(CancellationToken, SnapshotGate) -> Fut, Fut: Future<Output = Result<(), E>>,

Replaces the subscription and waits for a snapshot, with bounded retries.

Each send receives a child cancellation token. Dropping an attempt cancels queued transport work. Keeping this future alive across reconnects preserves the attempt limit and total elapsed-time budget. A zero snapshot timeout disables only the individual snapshot deadline.

§Errors

Returns the terminal adapter error, cancellation, or exhausted retry budget.

Trait Implementations§

Source§

impl<E: Debug> Debug for BookRecovery<E>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<E: Clone> Default for BookRecovery<E>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<E> !RefUnwindSafe for BookRecovery<E>

§

impl<E> !UnwindSafe for BookRecovery<E>

§

impl<E> Freeze for BookRecovery<E>
where Sender<BookRecoveryOutcome<E>>: Freeze,

§

impl<E> Send for BookRecovery<E>
where Sender<BookRecoveryOutcome<E>>: Send,

§

impl<E> Sync for BookRecovery<E>
where Sender<BookRecoveryOutcome<E>>: Sync,

§

impl<E> Unpin for BookRecovery<E>
where Sender<BookRecoveryOutcome<E>>: Unpin,

§

impl<E> UnsafeUnpin for BookRecovery<E>
where Sender<BookRecoveryOutcome<E>>: UnsafeUnpin,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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