helper

Documentation

Index

• func CheckForNil(params ...any) error
• func CheckPointerToStruct(v any) error
• func ClientEmail(ctx context.Context, u contract.Unmarshaler, b []byte) (string, error)
• func Deref(v reflect.Value) reflect.Value
• func EarlyReturn(ctx context.Context, e contract.EnvironmentOperator) (bool, error)
• func ErrorOrNil(err error) string
• func FromPointers[T any](in []*T) []T
• func IsCI() bool
• func IsUTC(d time.Time) bool
• func KeyBytes(ctx context.Context, u contract.Unmarshaler, b []byte) ([]byte, error)
• func ParseURL(raw string) *url.URL
• func Point[T any](x T) *T
• func PrettyJSON(ctx context.Context, m contract.Marshaler, u contract.Unmarshaler, r io.Reader) ([]byte, error)
• func RandomCode(length int) string
• func RangeString(low, high int) []string
• func Retry(opts RetryOptions, f func() error) error
• func SanitizeFilename(n string) string
• func SplitMime(mimeType string) string
• func StructToMap(v reflect.Value) map[string]any
• func ToPointers[T any](in []T) []*T
• type RetryOptions

Functions

func CheckForNil

func CheckForNil(params ...any) error

CheckForNil checks if any of the given parameters is nil.

func CheckPointerToStruct

func CheckPointerToStruct(v any) error

CheckPointerToStruct checks if the provided value is a pointer to a struct.

func ClientEmail

func ClientEmail(ctx context.Context, u contract.Unmarshaler, b []byte) (string, error)

ClientEmail returns the client email from the service account.

func Deref

func Deref(v reflect.Value) reflect.Value

Deref dereferences a pointer value recursively.

func EarlyReturn

func EarlyReturn(ctx context.Context, e contract.EnvironmentOperator) (bool, error)

EarlyReturn returns true if the current execution environment is a local, development or staging environment.

func ErrorOrNil

func ErrorOrNil(err error) string

ErrorOrNil returns the error message if not nil.

func FromPointers

func FromPointers[T any](in []*T) []T

FromPointers returns a slice of values from the given slice of pointers.

func IsCI

func IsCI() bool

IsCI returns true if the current execution environment is a CI pipeline.

func IsUTC

func IsUTC(d time.Time) bool

IsUTC checks if the given date is in UTC format.

func KeyBytes

func KeyBytes(ctx context.Context, u contract.Unmarshaler, b []byte) ([]byte, error)

KeyBytes returns the private key as bytes from the service account.

func ParseURL

func ParseURL(raw string) *url.URL

ParseURL parses a raw string into a *url.URL. Returns a non-nil empty *url.URL on failure.

func Point

func Point[T any](x T) *T

Point returns a pointer to the given value.

func PrettyJSON

func PrettyJSON(ctx context.Context, m contract.Marshaler, u contract.Unmarshaler, r io.Reader) ([]byte, error)

PrettyJSON pretty-prints a JSON stream using default indentation.

func RandomCode

func RandomCode(length int) string

RandomCode returns a random numeric string of the specified length.

func RangeString

func RangeString(low, high int) []string

RangeString returns a slice of stringified integers between low and high (inclusive).

func Retry

func Retry(opts RetryOptions, f func() error) error

Retry executes the provided function f at least once, retrying up to MaxRetries times if it fails. If MaxRetries is set to 0, the function will still run once. A delay is applied between retries. Returns nil if f succeeds within the allowed attempts; otherwise, returns the last encountered error.

func SanitizeFilename

func SanitizeFilename(n string) string

SanitizeFilename removes unsafe characters from a filename.

func SplitMime

func SplitMime(mimeType string) string

SplitMime returns the primary MIME prefix category from the given type.

func StructToMap

func StructToMap(v reflect.Value) map[string]any

StructToMap converts a struct to a map[string]any using reflection.

func ToPointers

func ToPointers[T any](in []T) []*T

ToPointers returns a slice of pointers to the given slice of values.

Types

type RetryOptions

type RetryOptions struct {
	MaxRetries uint
	RetryDelay time.Duration
}