Skip to main content

CheckpointManager

Struct CheckpointManager 

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

Manages file-based checkpoints for one or more workflows.

Each checkpoint is persisted as a JSON file named <storage_dir>/<workflow_id>.checkpoint.json.

Implementations§

Source§

impl CheckpointManager

Source

pub fn new(storage_dir: PathBuf) -> Self

Creates a new manager that stores checkpoints under storage_dir.

The directory is created on first use (lazily), so it does not need to exist at construction time.

Source

pub fn storage_dir(&self) -> &PathBuf

Returns the storage directory path.

Source

pub fn save(&self, checkpoint: &WorkflowCheckpoint) -> Result<()>

Serialises checkpoint to JSON and writes it to disk.

Overwrites any previously saved checkpoint for the same workflow_id.

§Errors

Returns WorkflowError::Io if the file cannot be written, or WorkflowError::Serialization if JSON serialisation fails.

Source

pub fn load(&self, workflow_id: &str) -> Result<WorkflowCheckpoint>

Reads and deserialises the checkpoint for workflow_id from disk.

§Errors

Returns WorkflowError::FileNotFound if no checkpoint exists, or WorkflowError::Io / WorkflowError::Serialization on read/parse failure.

Source

pub fn delete(&self, workflow_id: &str) -> Result<()>

Deletes the checkpoint file for workflow_id.

Returns Ok(()) even if no checkpoint file existed.

§Errors

Returns WorkflowError::Io if the file exists but cannot be removed.

Source

pub fn exists(&self, workflow_id: &str) -> bool

Returns true if a checkpoint file exists for workflow_id.

Source

pub fn list_checkpoints(&self) -> Result<Vec<String>>

Returns the workflow IDs of all checkpoints currently on disk.

Scans storage_dir for files matching *.checkpoint.json and strips the suffix to produce the workflow ID. Files that do not parse as valid checkpoints are silently skipped.

§Errors

Returns WorkflowError::Io if the storage directory cannot be read.

Trait Implementations§

Source§

impl Clone for CheckpointManager

Source§

fn clone(&self) -> CheckpointManager

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 CheckpointManager

Source§

fn fmt(&self, f: &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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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