transform

type CommandID struct {
	// contains filtered or unexported fields
}

type CommandType uint32

type StateMutator func(cmds []api.Cmd) error

type Transform interface {
	// BeginTransform is called before transforming any command.
	BeginTransform(ctx context.Context, inputState *api.GlobalState) error

	// EndTransform is called after all commands are transformed.
	EndTransform(ctx context.Context, inputState *api.GlobalState) ([]api.Cmd, error)

	// TransformCommand takes a given command list and a state.
	// It outputs a new set of commands after running the transformation.
	// Transforms must not modify the input commands:
	// they can add or remove commands in the command list,
	// but they must not edit the internals of the commands that they receive as input.
	TransformCommand(ctx context.Context, id CommandID, inputCommands []api.Cmd, inputState *api.GlobalState) ([]api.Cmd, error)

	// ClearTransformResources releases the resources that have been allocated during transform
	// Resources are needed for the state mutation, therefore this should be called after mutation.
	ClearTransformResources(ctx context.Context)

	// RequiresAccurateState returns true if the transform needs to observe the accurate state.
	RequiresAccurateState() bool

	// RequiresInnerStateMutation returns true if the transform needs to mutate state during the transformation
	RequiresInnerStateMutation() bool

	// SetInnerStateMutationFunction sets a mutator function for making a branch in the transform
	// to transform and mutate pending commands to be able to continue transform.
	SetInnerStateMutationFunction(stateMutator StateMutator)
}

type TransformChain struct {
	// contains filtered or unexported fields
}

type Writer interface {
	// State returns the state object associated with this writer.
	State() *api.GlobalState
	// MutateAndWrite mutates the state object associated with this writer,
	// and it passes the command to further consumers.
	MutateAndWrite(ctx context.Context, id api.CmdID, cmd api.Cmd) error
}