Skip to main content

CheckpointManager

Struct CheckpointManager 

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

Checkpoint manager for incremental checkpointing.

Implementations§

Source§

impl CheckpointManager

Source

pub fn new(interval: u64, max_storage: usize, compression_level: i32) -> Self

Create a new checkpoint manager.

Source

pub const fn should_checkpoint(&self, step: u64) -> bool

Check if a checkpoint should be created at this step.

Source

pub fn checkpoint( &mut self, time: SimTime, step: u64, state: &SimState, rng_state: RngState, ) -> SimResult<()>

Create and store a checkpoint.

§Errors

Returns error if checkpoint creation fails.

Source

pub fn get_checkpoint_at(&self, time: SimTime) -> Option<&Checkpoint>

Get checkpoint at or before given time.

Source

pub fn restore_at(&self, time: SimTime) -> SimResult<(SimState, SimTime)>

Restore state from nearest checkpoint.

§Errors

Returns error if no checkpoint found or restoration fails.

Source

pub fn num_checkpoints(&self) -> usize

Get number of stored checkpoints.

Source

pub const fn storage_used(&self) -> usize

Get current storage usage in bytes.

Source

pub fn clear(&mut self)

Clear all checkpoints.

Trait Implementations§

Source§

impl Debug for CheckpointManager

Source§

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

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

impl Default for CheckpointManager

Source§

fn default() -> CheckpointManager

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V