action

type Action ¶

type Action interface {
	Do()

	Undo()
	Undoable() bool

	Explain() string
}

Action models a "doable" and potentially "undoable" action.

If an action can be undone, its Undoable member is to return true, otherwise false. Iff Undoable returns false, Undo should be a no-op.

Actions can also -- e.g. for the purposes of help generation -- be described by Explain. Explain is to return a string describing the action Do would perform.

type Simple ¶

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

Simple implements the Action interface. It models a simple, non-undoable action as a func() which is called on Do.

func NewSimple(explainer func() string, action func()) *Simple

func (a *Simple) Do()

func (a *Simple) Explain() string

func (a *Simple) Undo()

func (a *Simple) Undoable() bool