cleaner

Documentation

Index

• func CleanupObject(c client.Client, object client.Object) func(ctx context.Context) error
• func CleanupOnError(ctx context.Context, c *Cleaner, err *error)
• type Cleaner
  • func New() *Cleaner
  • func (c *Cleaner) Add(f func(ctx context.Context) error)
  • func (c *Cleaner) Cleanup(ctx context.Context) error
  • func (c *Cleaner) Reset()

Functions

func CleanupObject

func CleanupObject(c client.Client, object client.Object) func(ctx context.Context) error

func CleanupOnError

func CleanupOnError(ctx context.Context, c *Cleaner, err *error)

Types

type Cleaner

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

Cleaner is an entity that allows tracking and executing cleanup methods.

func New

func New() *Cleaner

New instantiates a new Cleaner.

func (*Cleaner) Add

func (c *Cleaner) Add(f func(ctx context.Context) error)

Add adds the given function to the cleanup stack.

Cleanup functions will be executed in reverse order.

func (*Cleaner) Cleanup

func (c *Cleaner) Cleanup(ctx context.Context) error

Cleanup runs all cleanup functions with the given context, existing on the first error occurred.

func (*Cleaner) Reset

func (c *Cleaner) Reset()

Reset removes all cleanup functions from the cleaner.