helper

Documentation

Index

• func Abbreviate(s string) string
• func ArrayToMap[T any](m map[string]T, e []T, f func(T) string) map[string]T
• func BaseName(src string) string
• func Contains(a string, b string) bool
• func CopyDir(src, dst string) error
• func CopyFile(source, target string) error
• func Dir(path string) string
• func EachTicked[T any](ctx context.Context, items []T, fn func(T), dt time.Duration)
• func ExpandFiles(rootDir string, filter ExtFilter, inputs ...string) ([]string, error)
• func ExpandInputs(rootDir string, inputs ...string) ([]string, error)
• func Ext(file string) string
• func FallbackDir(name string, dirs ...string) (string, error)
• func FindDocuments(path string) ([]string, error)
• func GetDocumentType(path string) string
• func GetFreePort() (int, error)
• func HasExt(file string, exts ...string) bool
• func HttpPost(url string, contentType string, data []byte) error
• func HttpPostJson(url string, data interface{}) error
• func IsDir(elem string) bool
• func IsDocument(path string) bool
• func IsExist(path string) bool
• func IsFile(path string) bool
• func Join(elem ...string) string
• func ListDir(path string)
• func MakeDir(dst string) error
• func MakeIdGenerator(prefix string) func() string
• func MakeIntIdGenerator() func() uint64
• func MapToArray[T any](m map[string]T) []T
• func Must(err error)
• func NewUUID() string
• func ParseJson(data []byte, out any) error
• func ParseYaml(data []byte, out any) error
• func ReadDocument(path string, v any) error
• func ReadYamlFromData(in []byte, out any) error
• func ReadYamlFromString(in string, out any) error
• func RemoveDir(dst string) error
• func ScanFile(fn string) ([][]byte, error)
• func ScanNDJSON[T any](r io.Reader) ([]T, error)
• func ScanNDJSONFile[T any](path string) ([]T, error)
• func ToSlice(v any) []any
• func WaitForInterrupt(cancel func())
• func WriteDocument(path string, v any) error
• func WriteFile(dst string, data []byte) error
• func YamlToJson(in []byte) ([]byte, error)
• type EventEmitter
  • func NewEventEmitter[T any]() *EventEmitter[T]
  • func (e *EventEmitter[T]) Clear()
  • func (e *EventEmitter[T]) Emit(evt T)
  • func (e *EventEmitter[T]) On(handler EventHandler[T])
• type EventHandler
• type ExtFilter
• type HTTPSender
  • func NewHTTPSender(url string) *HTTPSender
  • func (s *HTTPSender) Send(data []byte, contentType string) error
  • func (s *HTTPSender) SendValue(value interface{}) error
  • func (s *HTTPSender) Write(data []byte) (int, error)
• type Iterator
  • func NewIterator[T any](items []T) Iterator[T]
• type SenderControl
  • func NewSenderControl[T any](repeat int, sleep time.Duration) *SenderControl[T]
  • func (t *SenderControl[T]) Run(items []T, send func(T) error) error

Functions

func Abbreviate

func Abbreviate(s string) string

Used by templates to generate abbreviation inside the code

func ArrayToMap

func ArrayToMap[T any](m map[string]T, e []T, f func(T) string) map[string]T

ArrayToMap converts an array to a map using a key function

func BaseName

func BaseName(src string) string

BaseName returns the last element of path.

func Contains

func Contains(a string, b string) bool

Contains checks if a string contains a substring case insensitive

func CopyDir

func CopyDir(src, dst string) error

func CopyFile

func CopyFile(source, target string) error

func Dir

func Dir(path string) string

func EachTicked

func EachTicked[T any](ctx context.Context, items []T, fn func(T), dt time.Duration)

EachTicked calls fn for each item in items every dt.

func ExpandFiles

func ExpandFiles(rootDir string, filter ExtFilter, inputs ...string) ([]string, error)

func ExpandInputs

func ExpandInputs(rootDir string, inputs ...string) ([]string, error)

func Ext

func Ext(file string) string

func FallbackDir

func FallbackDir(name string, dirs ...string) (string, error)

FallbackDir returns the first dir that exists.

func FindDocuments

func FindDocuments(path string) ([]string, error)

func GetDocumentType

func GetDocumentType(path string) string

func GetFreePort

func GetFreePort() (int, error)

func HasExt

func HasExt(file string, exts ...string) bool

func HttpPost

func HttpPost(url string, contentType string, data []byte) error

func HttpPostJson

func HttpPostJson(url string, data interface{}) error

func IsDir

func IsDir(elem string) bool

func IsDocument

func IsDocument(path string) bool

func IsExist

func IsExist(path string) bool

func IsFile

func IsFile(path string) bool

func Join

func Join(elem ...string) string

func ListDir

func ListDir(path string)

func MakeDir

func MakeDir(dst string) error

func MakeIdGenerator

func MakeIdGenerator(prefix string) func() string

func MakeIntIdGenerator

func MakeIntIdGenerator() func() uint64

func MapToArray

func MapToArray[T any](m map[string]T) []T

MapToArray converts a map to an array

func Must

func Must(err error)

func NewUUID

func NewUUID() string

func ParseJson

func ParseJson(data []byte, out any) error

func ParseYaml

func ParseYaml(data []byte, out any) error

func ReadDocument

func ReadDocument(path string, v any) error

func ReadYamlFromData

func ReadYamlFromData(in []byte, out any) error

func ReadYamlFromString

func ReadYamlFromString(in string, out any) error

func RemoveDir

func RemoveDir(dst string) error

func ScanFile

func ScanFile(fn string) ([][]byte, error)

func ScanNDJSON

func ScanNDJSON[T any](r io.Reader) ([]T, error)

Scan scans a reader line by line and writes to the writer.

func ScanNDJSONFile

func ScanNDJSONFile[T any](path string) ([]T, error)

ScanFile scans a file line by line and writes to the writer.

func ToSlice

func ToSlice(v any) []any

func WaitForInterrupt

func WaitForInterrupt(cancel func())

WaitForInterrupt handles SIGINT and SIGTERM signals. It cancels the context when a signal is received.

func WriteDocument

func WriteDocument(path string, v any) error

func WriteFile

func WriteFile(dst string, data []byte) error

func YamlToJson

func YamlToJson(in []byte) ([]byte, error)

Types

type EventEmitter

type EventEmitter[T any] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

EventEmitter is a typed event emitter.

func NewEventEmitter

func NewEventEmitter[T any]() *EventEmitter[T]

NewEventEmitter creates a new event emitter.

func (*EventEmitter[T]) Clear

func (e *EventEmitter[T]) Clear()

Clear removes all handlers.

func (*EventEmitter[T]) Emit

func (e *EventEmitter[T]) Emit(evt T)

Emit emits an event to all handlers.

func (*EventEmitter[T]) On

func (e *EventEmitter[T]) On(handler EventHandler[T])

On registers a new event handler.

type EventHandler

type EventHandler[T any] func(evt T)

EventHandler callback for an event.

type ExtFilter

type ExtFilter func(string) bool

type HTTPSender

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

func NewHTTPSender

func NewHTTPSender(url string) *HTTPSender

func (*HTTPSender) Send

func (s *HTTPSender) Send(data []byte, contentType string) error

Send sends the data to the sender.

func (*HTTPSender) SendValue

func (s *HTTPSender) SendValue(value interface{}) error

SendValue sends the value as json to the sender.

func (*HTTPSender) Write

func (s *HTTPSender) Write(data []byte) (int, error)

Write writes the event to the sender. This is used to implement the io.Writer interface. Data is send as json.

type Iterator

type Iterator[T any] interface {
	Next() (T, bool)
	HasNext() bool
}

func NewIterator

func NewIterator[T any](items []T) Iterator[T]

type SenderControl

type SenderControl[T any] struct {
	// contains filtered or unexported fields
}

func NewSenderControl

func NewSenderControl[T any](repeat int, sleep time.Duration) *SenderControl[T]

func (*SenderControl[T]) Run

func (t *SenderControl[T]) Run(items []T, send func(T) error) error