state

Documentation

Overview

Package state defines the model for a Run state.

Index

• type RunState
  • func (rs *RunState) CheckTree(ctx context.Context, tc tree.Client) (bool, error)
  • func (rs *RunState) LoadConfigGroup(ctx context.Context) (*prjcfg.ConfigGroup, error)
  • func (rs *RunState) ShallowCopy() *RunState

Types

type RunState

type RunState struct {
	Run run.Run

	// SubmissionScheduled is true if a submission will be attempted after state
	// transition completes.
	SubmissionScheduled bool
	// contains filtered or unexported fields
}

RunState represents the current state of a Run.

func (*RunState) CheckTree

func (rs *RunState) CheckTree(ctx context.Context, tc tree.Client) (bool, error)

CheckTree returns whether Tree is open for this Run.

Returns true if no Tree or Options.SkipTreeChecks is configured for this Run. Updates the latest result to `run.Submission`.

func (*RunState) LoadConfigGroup

func (rs *RunState) LoadConfigGroup(ctx context.Context) (*prjcfg.ConfigGroup, error)

LoadConfigGroup loads the ConfigGroup used by this Run.

Result is cached inside the state.

func (*RunState) ShallowCopy

func (rs *RunState) ShallowCopy() *RunState

ShallowCopy returns a shallow copy of run state