Struct TrialCheckpoints 

#[non_exhaustive]
pub struct TrialCheckpoints {
    pub refs: BTreeMap<u64, String>,
    pub replicates: BTreeMap<u32, BTreeMap<u64, String>>,
}

The checkpoint references a trial has recorded, keyed by resource step.

Each entry maps a step to an opaque reference string that atune stores but never reads. The map is ordered by step, so latest is the most advanced checkpoint — the one a fork or resume starts from.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

refs: BTreeMap<u64, String>

step -> reference, ordered by step.

replicates: BTreeMap<u32, BTreeMap<u64, String>>

replicate -> step -> reference for references recorded inside a multi-seed fan, ordered by replicate index and then by step. Empty for a trial that never ran as a fan.

Implementations

impl TrialCheckpoints

pub fn latest(&self) -> Option<(u64, &str)>

The most advanced checkpoint recorded, as (step, reference).

None when nothing has been recorded. This is the reference a Fork child or a resumed trial starts from.

pub fn at(&self, step: u64) -> Option<&str>

The reference recorded at exactly step, if any.

pub fn is_empty(&self) -> bool

true if no checkpoint has been recorded.

pub fn record(&mut self, step: u64, reference: impl Into<String>)

Records reference at step, replacing any reference already at that step.

pub fn latest_for(&self, replicate: u32) -> Option<(u64, &str)>

The most advanced checkpoint replicate recorded, as (step, reference).

None when that replicate recorded nothing; the trial-level latest is then the fallback a resume uses.

pub fn record_replicate( &mut self, replicate: u32, step: u64, reference: impl Into<String>, )

Records reference at step for one fan replicate, and at step on the trial level, replacing any reference already at either.

Trait Implementations

impl Clone for TrialCheckpoints

fn clone(&self) -> TrialCheckpoints

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrialCheckpoints

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

Formats the value using the given formatter.

impl Default for TrialCheckpoints

fn default() -> TrialCheckpoints

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrialCheckpoints

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TrialCheckpoints

impl PartialEq for TrialCheckpoints

fn eq(&self, other: &TrialCheckpoints) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TrialCheckpoints

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TrialCheckpoints