rollback

Documentation

Overview

Package rollback provides a friendly interface for rolling back partial state when parent tasks fail.

Index

• type Rollback
  • func New(runnable func()) *Rollback
  • func (r *Rollback) Done()
  • func (r *Rollback) OK()

Types

type Rollback

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

Rollback wraps a deferred cleanup task that can be cancelled if the parent task succeeds.

func New

func New(runnable func()) *Rollback

New creates a new Rollback with code to be run to cleanup a dirty state.

func (*Rollback) Done

func (r *Rollback) Done()

Done should be deferred immediately after creating a Rollback. It will run the cleanup task if the parent task fails to call OK.

func (*Rollback) OK

func (r *Rollback) OK()

OK should be called when the parent task succeeds. It will prevent the cleanup task from running.