utils

Documentation

Index

• Constants
• func EnsureNonNil[T any](s []T) []T
• func FindPhoneNumbers(s string, country i18n.Country) []string
• func Indent(s string, prefix string) string
• func IsValidAttachment(s string) bool
• func ParsePhoneNumber(s string, country i18n.Country) string
• func PrefixOverlap(s1, s2 string) int
• func ReadTypeFromJSON(data []byte) (string, error)
• func RegisterStructValidator(fn validator.StructLevelFunc, types ...any)
• func RegisterValidatorAlias(alias, tags string, message ErrorMessageFunc)
• func RegisterValidatorTag(tag string, fn validator.Func, message ErrorMessageFunc)
• func Set[K constraints.Ordered](s []K) map[K]bool
• func Snakify(text string) string
• func StringSliceContains(slice []string, str string, caseSensitive bool) bool
• func StringSlices(s string, indices []int) []string
• func TokenizeString(str string) []string
• func TokenizeStringByChars(str string, chars string) []string
• func TokenizeStringByUnicodeSeg(str string) []string
• func UnmarshalAndValidate(data []byte, obj any) error
• func UnmarshalAndValidateWithLimit(reader io.ReadCloser, s any, limit int64) error
• func Validate(obj any) error
• type Attachment
  • func (a Attachment) ContentType() string
  • func (a Attachment) ToParts() (string, string)
  • func (a Attachment) URL() string
• type ErrorMessageFunc
• type Typed
• type TypedEnvelope
• type ValidationErrors
  • func (e ValidationErrors) Error() string

Constants

const UnavailableType = "unavailable"

UnavailableType is the pseudo content type we use for attachments that couldn't be fetched

Functions

func EnsureNonNil

func EnsureNonNil[T any](s []T) []T

Until encoding/json/v2 there's no easy way to ensure nil slices are marshalled as empty arrays see https://github.com/golang/go/discussions/63397

func FindPhoneNumbers

func FindPhoneNumbers(s string, country i18n.Country) []string

FindPhoneNumbers finds phone numbers anywhere in the given string

func Indent

func Indent(s string, prefix string) string

Indent indents each non-empty line in the given string

func IsValidAttachment

func IsValidAttachment(s string) bool

IsValidAttachment returns whether the given string is a valid attachment

func ParsePhoneNumber

func ParsePhoneNumber(s string, country i18n.Country) string

ParsePhoneNumber tries to parse the given string as a phone number. If successful, it returns it formatted as E164.

func PrefixOverlap

func PrefixOverlap(s1, s2 string) int

PrefixOverlap returns the number of prefix characters which s1 and s2 have in common

func ReadTypeFromJSON

func ReadTypeFromJSON(data []byte) (string, error)

ReadTypeFromJSON reads a field called `type` from the given JSON

func RegisterStructValidator

func RegisterStructValidator(fn validator.StructLevelFunc, types ...any)

RegisterStructValidator registers a struct level validator

func RegisterValidatorAlias

func RegisterValidatorAlias(alias, tags string, message ErrorMessageFunc)

RegisterValidatorAlias registers a tag alias

func RegisterValidatorTag

func RegisterValidatorTag(tag string, fn validator.Func, message ErrorMessageFunc)

RegisterValidatorTag registers a tag

func Set

func Set[K constraints.Ordered](s []K) map[K]bool

Set converts a slice to a set (a K > bool map)

func Snakify

func Snakify(text string) string

Snakify turns the passed in string into a context reference. We replace all whitespace characters with _ and replace any duplicate underscores

func StringSliceContains

func StringSliceContains(slice []string, str string, caseSensitive bool) bool

StringSliceContains determines whether the given slice of strings contains the given string

func StringSlices

func StringSlices(s string, indices []int) []string

StringSlices returns the slices of s defined by pairs of indexes in indices

func TokenizeString

func TokenizeString(str string) []string

TokenizeString returns the words in the passed in string, split by non word characters including emojis

func TokenizeStringByChars

func TokenizeStringByChars(str string, chars string) []string

TokenizeStringByChars returns the words in the passed in string, split by the chars in the given string

func TokenizeStringByUnicodeSeg

func TokenizeStringByUnicodeSeg(str string) []string

TokenizeStringByUnicodeSeg tokenizes the given string using the Unicode Text Segmentation standard described at http://www.unicode.org/reports/tr29/

func UnmarshalAndValidate

func UnmarshalAndValidate(data []byte, obj any) error

UnmarshalAndValidate is a convenience function to unmarshal an object and validate it

func UnmarshalAndValidateWithLimit

func UnmarshalAndValidateWithLimit(reader io.ReadCloser, s any, limit int64) error

UnmarshalAndValidateWithLimit unmarshals a struct with a limit on how many bytes can be read from the given reader

func Validate

func Validate(obj any) error

Validate will run validation on the given object and return a set of field specific errors in the format: field <fieldname> <tag specific message>

For example: "field 'flows' is required"

Types

type Attachment

type Attachment string

Attachment is a media attachment on a message in the format <content-type>:<url>. Content type may be a full media type or may omit the subtype when it is unknown.

Examples:

• image/jpeg:http://s3.amazon.com/bucket/test.jpg
• image:http://s3.amazon.com/bucket/test.jpg

func (Attachment) ContentType

func (a Attachment) ContentType() string

ContentType returns the MIME type of this attachment

func (Attachment) ToParts

func (a Attachment) ToParts() (string, string)

ToParts splits an attachment string into content-type and URL

func (Attachment) URL

func (a Attachment) URL() string

URL returns the full URL of this attachment

type ErrorMessageFunc

type ErrorMessageFunc func(validator.FieldError) string

ErrorMessageFunc is the type for a function that can convert a field error to user friendly message

type Typed

type Typed interface {
	Type() string
}

Typed is an interface of objects that are marshalled as typed envelopes

type TypedEnvelope

type TypedEnvelope struct {
	Type string `json:"type" validate:"required"`
}

TypedEnvelope can be mixed into envelopes that have a type field

type ValidationErrors

type ValidationErrors []error

ValidationErrors combines multiple validation errors as a single error

func (ValidationErrors) Error

func (e ValidationErrors) Error() string

Error returns a string representation of these validation errors