cleanup

Documentation

Index

• type Steps
  • func (fns *Steps) Add(fn func() error)
  • func (fns *Steps) Unwind()

Types

type Steps

type Steps []func() error

Steps performs deferred cleanup on condition that an error was returned in the caller. This simplifies code where earlier steps need to be undone if a later step fails. It is not currently resilient to panics as this library is not expected to panic.

func (*Steps) Add

func (fns *Steps) Add(fn func() error)

Add appends the given cleanup function to those that will be called if an error occurs.

func (*Steps) Unwind

func (fns *Steps) Unwind()

Unwind calls the cleanup funcions in LIFO order. It panics if any of them return an error as failure during recovery is itself unrecoverable.