Skip to main content

CheckpointManager

Struct CheckpointManager 

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

Manages in-process checkpoint state for resumable sessions.

Each checkpoint atomically stores an event and the updated run-state so that a crash cannot leave an event emitted but un-checkpointed (or vice versa).

§Example

use adk_managed::checkpoint::{CheckpointManager, RunState};
use adk_managed::types::{SessionEvent, SessionStatus, ContentBlock};

let mut mgr = CheckpointManager::new("session_001".to_string());

let event = SessionEvent::StatusRunning { seq: 0 };
let state = RunState { seq: 1, pending_tool_ids: vec![], status: SessionStatus::Running };
mgr.checkpoint(event, state.clone());

assert_eq!(mgr.events().len(), 1);
assert_eq!(mgr.run_state(), &state);

Implementations§

Source§

impl CheckpointManager

Source

pub fn new(session_id: String) -> Self

Create a new checkpoint manager for the given session.

Initializes with an empty event log and the initial run state (seq=0, no pending tools, queued status).

Source

pub fn with_store(self, store: Arc<dyn ManagedStateStore>) -> Self

Writes flushed checkpoints to store.

Check ManagedStateStore::durability to learn whether those writes survive process loss. With the shipped InMemoryManagedStateStore they do not.

§Example
use adk_managed::{CheckpointManager, InMemoryManagedStateStore};
use std::sync::Arc;

let manager = CheckpointManager::new("session-1".to_string())
    .with_store(Arc::new(InMemoryManagedStateStore::new()));
assert!(manager.store().is_some());
Source

pub fn store(&self) -> Option<&Arc<dyn ManagedStateStore>>

The configured store, if any.

Source

pub async fn flush(&self) -> Result<(), RuntimeError>

Writes the current snapshot to the configured store.

A no-op without a store. Separate from CheckpointManager::checkpoint because that method is synchronous and a store write is not; a caller that needs the snapshot externally visible must flush.

§Errors

Returns RuntimeError when the store rejects the write.

Source

pub async fn restore( session_id: String, store: Arc<dyn ManagedStateStore>, ) -> Result<Self, RuntimeError>

Rebuilds a manager for session_id from store.

Returns a manager with the stored snapshot when one exists, and an empty one otherwise. Whether anything is found across a restart depends entirely on the store’s durability — with the in-memory backend a new process finds nothing.

§Errors

Returns RuntimeError when the store cannot be read.

Source

pub fn checkpoint(&mut self, event: SessionEvent, run_state: RunState)

Records an event and the updated run state together.

The pair is applied in one call, so replay never sees an event without its state. This is a write to this manager’s own fields, not a transaction with a persistent store: it says nothing about surviving a crash. Call CheckpointManager::flush to write the snapshot out, and check the store’s durability to learn what that write guarantees.

Source

pub fn load_checkpoint(&self) -> (Vec<SessionEvent>, RunState)

The events and run state this manager holds, for resume within the process.

Reconstructing a session in a different process requires a crash-durable ManagedStateStore and CheckpointManager::restore; this method reads local fields only.

Source

pub fn events(&self) -> &[SessionEvent]

Get all events stored in the checkpoint log.

Source

pub fn run_state(&self) -> &RunState

Get current run state.

Source

pub fn session_id(&self) -> &str

Get the session ID this manager is checkpointing for.

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

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