Skip to main content

Durability

Enum Durability 

Source
pub enum Durability {
    Sync,
    Async,
    Exit,
    Every {
        n: u64,
        mode: Box<Durability>,
    },
    Custom(Arc<dyn DurabilityHook>),
}
Expand description

Checkpoint timing relative to step execution.

Variants§

§

Sync

Await cp.save inline after each step (default).

§

Async

Spawn cp.save without awaiting. Crash before the spawn lands loses the most recent step.

§

Exit

Save only at graph completion. No intermediate checkpoints.

§

Every

Save every Nth step (n>=1) using the wrapped sub-mode for that step. Other steps are skipped. The graph-completion save is always emitted regardless of stride.

Fields

§n: u64

Stride. 1 means “every step” (equivalent to the wrapped mode).

§mode: Box<Durability>

Mode used on the Nth step.

§

Custom(Arc<dyn DurabilityHook>)

Fully user-defined policy.

Implementations§

Source§

impl Durability

Source

pub fn decide(&self, step: u64, is_terminal: bool) -> DurabilityDecision

Decide what action to take at the end of step. is_terminal is true on the graph-completion save (always honored except for Skip-returning custom hooks that opt out).

Source

pub fn save_per_step_sync(&self) -> bool

True if the engine should save inline after each step.

Source

pub fn save_per_step_async(&self) -> bool

True if the engine should spawn an async save after each step.

Source

pub fn save_on_exit(&self) -> bool

True if a final-only save should be emitted on graph completion.

Trait Implementations§

Source§

impl Clone for Durability

Source§

fn clone(&self) -> Durability

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 Durability

Source§

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

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

impl Default for Durability

Source§

fn default() -> Durability

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

impl PartialEq for Durability

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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