utils

Documentation

Index

• Constants
• func DurationTo8601Seconds(duration time.Duration) string
• func DurationToStringPtr(duration *time.Duration) *string
• func ISO8601StringToDuration(durationStr *string) (*time.Duration, error)
• func Int32ToPtr(val *int32) *int32
• func Retry(ctx context.Context, eventName log.Event, operation string, ...) error
• type Logger
  • func NewLogger() Logger
  • func (l *Logger) Prefix() string
  • func (l *Logger) SetPrefix(format string, args ...any)
  • func (l *Logger) Writef(evt azlog.Event, format string, args ...any)
• type RetryFnArgs
  • func (rf *RetryFnArgs) ResetAttempts()

Constants

const EventRetry = "azsb.Retry"

EventRetry is the name for retry events

const MaxTimeDuration = time.Duration(1<<63 - 1)

straight from 'time.go'

Functions

func DurationTo8601Seconds

func DurationTo8601Seconds(duration time.Duration) string

DurationTo8601Seconds takes a duration and returns a string period of whole seconds (int cast of float)

func DurationToStringPtr

func DurationToStringPtr(duration *time.Duration) *string

DurationToStringPtr converts a time.Duration to an ISO8601 duration as a string pointer.

func ISO8601StringToDuration

func ISO8601StringToDuration(durationStr *string) (*time.Duration, error)

ISO8601StringToDuration converts an ISO8601 string to a Go time.Duration

func Int32ToPtr

func Int32ToPtr(val *int32) *int32

func Retry

func Retry(ctx context.Context, eventName log.Event, operation string, fn func(ctx context.Context, args *RetryFnArgs) error, isFatalFn func(err error) bool, o exported.RetryOptions) error

Retry runs a standard retry loop. It executes your passed in fn as the body of the loop. It returns if it exceeds the number of configured retry options or if 'isFatal' returns true.

Types

type Logger

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

func NewLogger

func NewLogger() Logger

func (*Logger) Prefix

func (l *Logger) Prefix() string

func (*Logger) SetPrefix

func (l *Logger) SetPrefix(format string, args ...any)

func (*Logger) Writef

func (l *Logger) Writef(evt azlog.Event, format string, args ...any)

type RetryFnArgs

type RetryFnArgs struct {
	// I is the iteration of the retry "loop" and starts at 0.
	// The 0th iteration is the first call, and doesn't count as a retry.
	// The last try will equal RetryOptions.MaxRetries
	I int32
	// LastErr is the returned error from the previous loop.
	// If you have potentially expensive
	LastErr error
	// contains filtered or unexported fields
}

func (*RetryFnArgs) ResetAttempts

func (rf *RetryFnArgs) ResetAttempts()

ResetAttempts resets all Retry() attempts, starting back at iteration 0.