Struct Study 

pub struct Study { /* private fields */ }

Non-clone scheduler and display owner for one declared study plan.

Implementations

impl Study

pub fn builder(record_path: impl Into<PathBuf>) -> StudyBuilder

Starts an empty builder with the mandatory study-record destination.

pub fn phases(&self) -> &[Phase]

Borrows all registered phases in deterministic declaration order.

pub fn plan(&self) -> StudyPlan

Materializes a deterministic, side-effect-free description of every registered phase and task.

pub fn write_plan_json(&self, path: impl AsRef<Path>) -> Result<(), StudyError>

Writes the complete registered plan as pretty JSON without running it. An existing byte-identical file is accepted. Different existing content is rejected and never overwritten.

pub fn phase(&self, id: impl Into<PhaseId>) -> Option<&Phase>

Borrows one registered phase by stable ID.

pub fn cancellation_token(&self) -> CancellationToken

Returns a cheap token that can request or observe study cancellation.

pub fn unique_task_matching( &self, selector: &TaskSelector, ) -> Result<&Task, StudyError>

Returns the unique task matching an exact partial selector.

pub fn run(self) -> Result<StudySummary, StudyError>

Runs every registered phase in dependency order.

pub fn run_phases<I, P>(self, phases: I) -> Result<StudySummary, StudyError>

where I: IntoIterator<Item = P>, P: Into<PhaseId>,

Runs exactly the selected phases; omitted unsatisfied dependencies fail.

pub fn run_phases_with_dependencies<I, P>( self, phases: I, ) -> Result<StudySummary, StudyError>

where I: IntoIterator<Item = P>, P: Into<PhaseId>,

Adds unsatisfied dependencies and runs the deterministic closure.

Trait Implementations

impl Debug for Study

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

Formats the value using the given formatter.