Skip to main content

FaultRuntime

Struct FaultRuntime 

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

The validated fault-tolerance capability installed on a chunk step.

The bundle owns the policy, the injected monotonic sleeper, the reservation store, and the declared delivery mode. Capabilities are validated at construction so a statically impossible combination cannot reach user work.

use std::sync::Arc;
use std::time::Duration;

use oxide_batch::{
    BackoffOutcome, BackoffPolicy, BackoffSleeper, BoxFuture, ChunkDeliveryMode,
    ClassifierRevision, FailureCategory, FaultAction, FaultClassifier, FaultPhase, FaultPolicy,
    FaultRule, FaultRuntime, InMemoryFaultState, RetryLimit, RetryStateLimit, SkipLimit,
    StopToken,
};

struct ImmediateSleeper;

impl BackoffSleeper for ImmediateSleeper {
    fn sleep<'a>(
        &'a self,
        _delay: Duration,
        stop: &'a StopToken,
    ) -> BoxFuture<'a, BackoffOutcome> {
        let stopped = stop.is_stop_requested();
        Box::pin(async move {
            if stopped { BackoffOutcome::Stopped } else { BackoffOutcome::Elapsed }
        })
    }
}

let policy = FaultPolicy::new(
    FaultClassifier::new(
        ClassifierRevision::new("import_v1")?,
        [FaultRule::new(
            FaultPhase::Write,
            FailureCategory::Timeout,
            FaultAction::retry(),
        )?],
    )?,
    RetryLimit::new(2)?,
    RetryStateLimit::new(16)?,
    SkipLimit::NONE,
    BackoffPolicy::fixed(Duration::from_millis(10))?,
)?;
let state = Arc::new(InMemoryFaultState::new(policy.retry_state_limit()));
let runtime = FaultRuntime::new(
    policy,
    Arc::new(ImmediateSleeper),
    state,
    ChunkDeliveryMode::AtLeastOnce,
)?;
assert_eq!(runtime.delivery_mode(), ChunkDeliveryMode::AtLeastOnce);

Implementations§

Source§

impl FaultRuntime

Source

pub fn new( policy: FaultPolicy, sleeper: Arc<dyn BackoffSleeper>, state: Arc<dyn FaultStateStore>, delivery_mode: ChunkDeliveryMode, ) -> Result<Self, FaultPolicyError>

Validates and installs the fault-tolerance capability.

§Errors

Returns crate::FaultPolicyError::CommitSafeSkipUnsupported when the policy accepts a commit-safe skip that the declared delivery mode cannot commit atomically.

Source

pub fn policy(&self) -> &FaultPolicy

Borrows the validated step policy.

Source

pub fn sleeper(&self) -> &dyn BackoffSleeper

Borrows the injected monotonic sleeper.

Source

pub fn state(&self) -> &dyn FaultStateStore

Borrows the reservation store.

Source

pub const fn delivery_mode(&self) -> ChunkDeliveryMode

Returns the delivery mode declared for this step.

Trait Implementations§

Source§

impl Clone for FaultRuntime

Source§

fn clone(&self) -> FaultRuntime

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FaultRuntime

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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