Skip to main content

FileCheckpointStore

Struct FileCheckpointStore 

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

Durable checkpoint store that persists one checkpoint per JSON file.

Checkpoints are written atomically, so a failed save never leaves a partial or zero-length live file behind. Checkpoint IDs are validated before file access and therefore must not contain path separators, .., :, or ASCII control characters.

Retention is unbounded by default. Use with_max_checkpoints to prune older checkpoints after each save.

All filesystem work runs on Tokio’s blocking pool via tokio::task::spawn_blocking, so the returned futures never stall an async worker thread and must be polled inside a Tokio runtime.

Implementations§

Source§

impl FileCheckpointStore

Source

pub const DEFAULT_MAX_CHECKPOINTS: usize = 20

Recommended bound for callers that want capped checkpoint retention.

New stores are unbounded by default for backwards compatibility with the public checkpoint policy contract.

Source

pub fn new(checkpoints_dir: PathBuf) -> Result<Self>

Create a new store rooted at the given directory.

Creates the directory (and parents) if it does not already exist.

The store keeps every checkpoint by default; see Self::with_max_checkpoints to opt into bounded retention.

Source

pub fn default_dir() -> Option<PathBuf>

Default checkpoints directory: <config_dir>/swink-agent/checkpoints.

Source

pub fn with_max_checkpoints(self, n: usize) -> Self

Keep at most n checkpoints, pruning the oldest (by created_at) after each save.

The checkpoint just saved counts toward the limit, so n should be at least 1. Self::DEFAULT_MAX_CHECKPOINTS is a reasonable preset for callers that do not need every historical checkpoint.

Pruning only considers files in the store directory that parse as checkpoints; foreign or malformed files are never deleted. Pruning is best-effort: failures are logged at warn level and never fail the save that triggered them.

Source

pub fn unbounded(self) -> Self

Disable retention pruning and keep every checkpoint.

This is the default for new stores. It is also useful after a builder chain has temporarily selected a bound. Disk usage then grows without bound: a per-turn checkpoint policy leaves one growing file per turn, so an N-turn session stores O(N²) bytes. Prefer a bound unless every historical checkpoint is needed.

Trait Implementations§

Source§

impl CheckpointStore for FileCheckpointStore

Source§

fn save_checkpoint(&self, checkpoint: Checkpoint) -> CheckpointFuture<'_, ()>

Save a checkpoint. Overwrites any existing checkpoint with the same ID.
Source§

fn load_checkpoint(&self, id: &str) -> CheckpointFuture<'_, Option<Checkpoint>>

Load a checkpoint by ID.
Source§

fn list_checkpoints(&self) -> CheckpointFuture<'_, Vec<String>>

List all checkpoint IDs, most recent first.
Source§

fn delete_checkpoint(&self, id: &str) -> CheckpointFuture<'_, ()>

Delete a checkpoint by ID.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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