helpers

Documentation

Overview

Package helpers contains helpers to assist in other parts of the code

Index

• func CleanNetworkAddressFromError(err error) error
• func Ptr[T any](v T) *T
• func Retry(fn func() error) error
• func RetryTransaction(db *gorm.DB, fn func(tx *gorm.DB) error) error
• func SchemaValidateTemplateField(tplValidator func(string) error, fields ...string) fieldcollection.ValidateOpt

Functions

func CleanNetworkAddressFromError

func CleanNetworkAddressFromError(err error) error

CleanNetworkAddressFromError checks whether an IP:Port->IP:port information is contained in the error. This is checked by explicitly sanitizing *net.OpError instances or by returning a sanitized error string without the stack previously present.

As of the loss of information this is only intended to clean up logging and not be used in error returns.

func Ptr

func Ptr[T any](v T) *T

Ptr creates a pointer to any given type

func Retry

func Retry(fn func() error) error

Retry contains a standard set of configuration parameters for an exponential backoff to be used throughout the bot

func RetryTransaction

func RetryTransaction(db *gorm.DB, fn func(tx *gorm.DB) error) error

RetryTransaction takes a database object and a function acting on the database. The function will be run in a transaction on the database and will be retried as if executed using Retry

func SchemaValidateTemplateField

func SchemaValidateTemplateField(tplValidator func(string) error, fields ...string) fieldcollection.ValidateOpt

SchemaValidateTemplateField contains a ValidateOpt for the fieldcollection schema validator to validate template fields