Struct Session 

pub struct Session { /* private fields */ }

Implementations

impl Session

pub fn open(store: WarmStartStore, key: Fingerprint) -> Self

pub fn preload(&self, entry: WarmStartEntry)

Stash a near-match payload that the next Self::try_load call should return in preference to looking up this session’s key.

Used by the workflow dispatcher to seed a fresh fit’s outer loop from a related but not-exact-fingerprint prior fit (e.g., cross-validation folds of the same model). The exact-key keyspace remains untouched by this — checkpoint and finalize writes still go to the session’s own key.

pub fn key(&self) -> &Fingerprint

pub fn run_id(&self) -> &str

pub fn store(&self) -> &WarmStartStore

pub fn try_load(&self) -> Option<WarmStartEntry>

Read the best entry currently on disk for this session’s key. Lookup is read-only against the store and may return entries from other runs (the whole point of cross-run resume).

If a near-match seed has been preloaded via Self::preload, the seed is returned in preference to the store lookup AND consumed (so subsequent calls fall back to the store). This makes the session a unified abstraction over “exact-key hit” and “hierarchical-prefix seed.”

pub fn try_load_with_source(&self) -> Option<LoadedEntry>

Read the best available warm-start entry and report whether it came from this session’s exact key or from a preloaded near-match seed.

Callers that only need a seed can use Self::try_load. Callers that may skip expensive validation on a finalized exact hit need this source bit so a near-match prefix seed is never mistaken for a completed fit.

pub fn peek_load(&self) -> Option<WarmStartEntry>

Read the currently available warm-start entry without consuming a preloaded near-match seed.

This is intentionally separate from Self::try_load: callers that only need to make a scheduling decision (for example, whether to run an expensive cold-start pilot) must not drain the preloaded seed that the outer optimizer is about to consume.

pub fn peek_load_with_source(&self) -> Option<LoadedEntry>

Read the currently available warm-start entry with source metadata, without consuming a preloaded near-match seed.

pub fn checkpoint( &self, payload: &[u8], objective: Option<f64>, iteration: Option<u64>, ) -> bool

Persist a mid-fit checkpoint. Rate-limited; returns true if a write actually happened. Always writes when the new objective strictly improves on the best-so-far observed in this session.

pub fn finalize( &self, payload: &[u8], objective: Option<f64>, iteration: Option<u64>, ) -> bool

Persist the end-of-fit result, promoting this session’s slot to EntryKind::Final. Bypasses the rate limit.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.