Struct SavePlan 

pub struct SavePlan {

    pub verb: SaveVerb,
    pub intent: Option<String>,
    pub confidence: Option<f32>,
    pub attribution: Attribution,
    pub git_scope: GitScope,
    pub supplied_tree: Option<Tree>,
    pub reuse_current_state: bool,
    pub require_clean_worktree: bool,
    pub require_worktree_change: bool,
    pub worktree_status_options: WorktreeStatusOptions,
    pub run_hooks: bool,
    pub commit_safe_post_verify: bool,
    pub coalesce_snapshot_and_checkpoint: bool,
    pub linearize_git_parent: bool,
    pub precomputed_worktree_status: Option<Result<Option<WorktreeStatus>>>,
    pub machine_contract_input: Option<MachineContractInput>,
}

Inputs for execute_save. Attribution is resolved by the caller so CLI env/harness/agent precedence stays at the embedding surface.

Fields

verb: SaveVerb

intent: Option<String>

confidence: Option<f32>

attribution: Attribution

git_scope: GitScope

supplied_tree: Option<Tree>

When set, snapshot this tree instead of walking the worktree (staged-index commits).

reuse_current_state: bool

Prefer the current HEAD state when present (checkpoint bootstrap path).

require_clean_worktree: bool

After ensuring state, refuse dirty Heddle worktree before Git write-through.

require_worktree_change: bool

Refuse a worktree snapshot whose tree is identical to the current state. The comparison happens during the snapshot tree build, avoiding a separate preflight walk.

worktree_status_options: WorktreeStatusOptions

run_hooks: bool

Run pre/post snapshot hooks when creating a new Heddle state.

commit_safe_post_verify: bool

Map post-verify “commit” next actions to heddle status (commit UX).

coalesce_snapshot_and_checkpoint: bool

Fold snapshot + GitCheckpoint oplog batches into one undo unit.

linearize_git_parent: bool

Export an unmapped checkpoint state on top of the checkout’s current Git tip. Used only by sequential multi-peer land.

precomputed_worktree_status: Option<Result<Option<WorktreeStatus>>>

Optional precomputed git-overlay worktree status for verification reuse on the no-new-state path. Post-mutation paths always recompute.

machine_contract_input: Option<MachineContractInput>

Optional embedding-surface machine-contract inventory. Passing it into core verification lets callers reuse the post-save proof instead of rebuilding the entire repository health envelope for presentation.

Implementations

impl SavePlan

pub fn capture(intent: impl Into<String>, attribution: Attribution) -> Self

pub fn commit( intent: impl Into<String>, attribution: Attribution, git_scope: GitScope, ) -> Self

pub fn checkpoint( message: Option<String>, attribution: Attribution, staged: bool, ) -> Self

pub fn with_confidence(self, confidence: Option<f32>) -> Self

pub fn with_supplied_tree(self, tree: Tree) -> Self

pub fn with_worktree_status_options( self, options: WorktreeStatusOptions, ) -> Self

pub fn with_precomputed_worktree_status( self, status: Result<Option<WorktreeStatus>>, ) -> Self

Trait Implementations

impl Debug for SavePlan

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

Formats the value using the given formatter.