retries

Documentation

Index

• func Backoff(attempt int) time.Duration
• func Poll[T any](pctx context.Context, timeout time.Duration, fn func() (*T, *Err)) (*T, error)
• func Wait(pctx context.Context, timeout time.Duration, fn WaitFn) error
• type Err
  • func Continue(err error) *Err
  • func Continuef(format string, err error, args ...interface{}) *Err
  • func Continues(msg string) *Err
  • func Halt(err error) *Err
• type Info
• type Option
  • func OnPoll[T any](callback func(*T)) Option[T]
  • func Timeout[T any](dur time.Duration) Option[T]
• type WaitFn

Functions

func Backoff

func Backoff(attempt int) time.Duration

func Poll

func Poll[T any](pctx context.Context, timeout time.Duration, fn func() (*T, *Err)) (*T, error)

func Wait

func Wait(pctx context.Context, timeout time.Duration, fn WaitFn) error

Types

type Err

type Err struct {
	Err  error
	Halt bool
}

func Continue

func Continue(err error) *Err

func Continuef

func Continuef(format string, err error, args ...interface{}) *Err

func Continues

func Continues(msg string) *Err

func Halt

func Halt(err error) *Err

type Info

type Info[T any] struct {
	Info    *T
	Timeout time.Duration
}

Deprecated: use return types from non-*AndWait methods

type Option

type Option[T any] func(*Info[T])

Deprecated: use return types from non-*AndWait methods

func OnPoll

func OnPoll[T any](callback func(*T)) Option[T]

Deprecated: use return types from non-*AndWait methods

func Timeout

func Timeout[T any](dur time.Duration) Option[T]

Deprecated: use return types from non-*AndWait methods

type WaitFn

type WaitFn func() *Err