toolbelt

README

toolbelt

A set of utilities used in every go project

Documentation

Index

• Constants
• func AliasHash(alias string) int64
• func AliasHashEncoded(alias string) string
• func AliasHashEncodedf(format string, args ...interface{}) string
• func AliasHashf(format string, args ...interface{}) int64
• func Camel(s string) string
• func Clamp[T Float](v T, minimum T, maximum T) T
• func Clamp01[T Float](v T) T
• func ClampFit[T Float](x T, oldMin T, oldMax T, newMin T, newMax T) T
• func ClampFit01[T Float](x T, newMin T, newMax T) T
• func CtxSlog(ctx context.Context) (logger *slog.Logger, ok bool)
• func CtxWithSlog(ctx context.Context, slog *slog.Logger) context.Context
• func Fit[T Float](x T, oldMin T, oldMax T, newMin T, newMax T) T
• func Fit01[T Float](x T, newMin T, newMax T) T
• func FitMax[T Float](x T, newMax T) T
• func JulianDayToTime(d float64) time.Time
• func JulianDayToTimeStmt(stmt *sqlite.Stmt, param string) time.Time
• func JulianDayToTimestamp(f float64) *timestamppb.Timestamp
• func JulianDayToTimestampStmt(stmt *sqlite.Stmt, param string) *timestamppb.Timestamp
• func JulianNow() float64
• func Kebab(s string) string
• func Lower(s string) string
• func NextEncodedID() string
• func NextID() int64
• func Pascal(s string) string
• func RandIntRange[T Integer](r *rand.Rand, min, max T) T
• func RandNegOneToOneClamped[T Float](r *rand.Rand) T
• func RoundFit01[T Float](x T, newMin T, newMax T) T
• func Snake(s string) string
• func TimeToJulianDay(t time.Time) float64
• func TimestampJulian(ts *timestamppb.Timestamp) float64
• func Upper(s string) string
• func UpsertStream(js nats.JetStreamContext, cfg *nats.StreamConfig) (si *nats.StreamInfo, err error)
• type CasedString
  • func Cased(s string) CasedString
• type CtxErrFunc
• type CtxKey
• type Database
  • func NewDatabase(ctx context.Context, dbFilename string, migrations []string) (*Database, error)
  • func (db *Database) Close() error
  • func (db *Database) ReadTX(ctx context.Context, fn TxFn) (err error)
  • func (db *Database) WriteTX(ctx context.Context, fn TxFn) (err error)
• type EmbeddedNATsServer
  • func NewEmbeddedNATsServer(ctx context.Context, clearData bool) (*EmbeddedNATsServer, error)
  • func (n *EmbeddedNATsServer) Client() (*nats.Conn, error)
  • func (n *EmbeddedNATsServer) Close() error
  • func (n *EmbeddedNATsServer) WaitForServer()
• type ErrGroupSeparateCtx
  • func NewErrGroupSeparateCtx() *ErrGroupSeparateCtx
  • func (egc *ErrGroupSeparateCtx) Go(ctx context.Context, funcs ...CtxErrFunc)
  • func (egc *ErrGroupSeparateCtx) Wait() error
• type ErrGroupSharedCtx
  • func NewErrGroupSharedCtx(ctx context.Context, funcs ...CtxErrFunc) *ErrGroupSharedCtx
  • func (egc *ErrGroupSharedCtx) Go(funcs ...CtxErrFunc)
  • func (egc *ErrGroupSharedCtx) Wait() error
• type Float
• type Integer
• type TxFn
• type TypedIdFunc
• type TypedKV
  • func UpsertTypedKV[T protoreflect.ProtoMessage](js nats.JetStreamContext, cfg *nats.KeyValueConfig, newFn TypedNewFunc[T], ...) (*TypedKV[T], error)
  • func (tkv *TypedKV[T]) All() (out []T, err error)
  • func (tkv *TypedKV[T]) Batch(values ...T) (err error)
  • func (tkv *TypedKV[T]) Delete(value T) (err error)
  • func (tkv *TypedKV[T]) DeleteKey(key string) (err error)
  • func (t *TypedKV[T]) Get(key string) (T, uint64, error)
  • func (tkv *TypedKV[T]) Keys() ([]string, error)
  • func (tkv *TypedKV[T]) Load(keys ...string) (loaded []T, err error)
  • func (tkv *TypedKV[T]) Set(value T) (revision uint64, err error)
  • func (tkv *TypedKV[T]) Update(value T, last uint64) (revision uint64, err error)
• type TypedNewFunc

Constants

const (
	UnixEpochJulianDay = 2440587.5
)

Functions

func AliasHash

func AliasHash(alias string) int64

func AliasHashEncoded

func AliasHashEncoded(alias string) string

func AliasHashEncodedf

func AliasHashEncodedf(format string, args ...interface{}) string

func AliasHashf

func AliasHashf(format string, args ...interface{}) int64

func Camel

func Camel(s string) string

func Clamp

func Clamp[T Float](v T, minimum T, maximum T) T

func Clamp01

func Clamp01[T Float](v T) T

func ClampFit

func ClampFit[T Float](
	x T,
	oldMin T,
	oldMax T,
	newMin T,
	newMax T,
) T

func ClampFit01

func ClampFit01[T Float](x T, newMin T, newMax T) T

func CtxSlog

func CtxSlog(ctx context.Context) (logger *slog.Logger, ok bool)

func CtxWithSlog

func CtxWithSlog(ctx context.Context, slog *slog.Logger) context.Context

func Fit

func Fit[T Float](
	x T,
	oldMin T,
	oldMax T,
	newMin T,
	newMax T,
) T

func Fit01

func Fit01[T Float](x T, newMin T, newMax T) T

func FitMax

func FitMax[T Float](x T, newMax T) T

func JulianDayToTime

func JulianDayToTime(d float64) time.Time

JulianDayToTime converts a Julian day into a time.Time.

func JulianDayToTimeStmt

func JulianDayToTimeStmt(stmt *sqlite.Stmt, param string) time.Time

func JulianDayToTimestamp

func JulianDayToTimestamp(f float64) *timestamppb.Timestamp

func JulianDayToTimestampStmt

func JulianDayToTimestampStmt(stmt *sqlite.Stmt, param string) *timestamppb.Timestamp

func JulianNow

func JulianNow() float64

func Kebab

func Kebab(s string) string

func Lower

func Lower(s string) string

func NextEncodedID

func NextEncodedID() string

func NextID

func NextID() int64

func Pascal

func Pascal(s string) string

func RandIntRange

func RandIntRange[T Integer](r *rand.Rand, min, max T) T

func RandNegOneToOneClamped

func RandNegOneToOneClamped[T Float](r *rand.Rand) T

func RoundFit01

func RoundFit01[T Float](x T, newMin T, newMax T) T

func Snake

func Snake(s string) string

func TimeToJulianDay

func TimeToJulianDay(t time.Time) float64

TimeToJulianDay converts a time.Time into a Julian day.

func TimestampJulian

func TimestampJulian(ts *timestamppb.Timestamp) float64

func Upper

func Upper(s string) string

func UpsertStream

func UpsertStream(js nats.JetStreamContext, cfg *nats.StreamConfig) (si *nats.StreamInfo, err error)

Types

type CasedString

type CasedString struct {
	Original string
	Pascal   string
	Camel    string
	Snake    string
	Kebab    string
	Upper    string
	Lower    string
}

func Cased

func Cased(s string) CasedString

type CtxErrFunc

type CtxErrFunc func(ctx context.Context) error

type CtxKey

type CtxKey string

const CtxSlogKey CtxKey = "slog"

type Database

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

func NewDatabase

func NewDatabase(ctx context.Context, dbFilename string, migrations []string) (*Database, error)

func (*Database) Close

func (db *Database) Close() error

func (*Database) ReadTX

func (db *Database) ReadTX(ctx context.Context, fn TxFn) (err error)

func (*Database) WriteTX

func (db *Database) WriteTX(ctx context.Context, fn TxFn) (err error)

type EmbeddedNATsServer

type EmbeddedNATsServer struct {
	NatsServer *server.Server
}

func NewEmbeddedNATsServer

func NewEmbeddedNATsServer(ctx context.Context, clearData bool) (*EmbeddedNATsServer, error)

func (*EmbeddedNATsServer) Client

func (n *EmbeddedNATsServer) Client() (*nats.Conn, error)

func (*EmbeddedNATsServer) Close

func (n *EmbeddedNATsServer) Close() error

func (*EmbeddedNATsServer) WaitForServer

func (n *EmbeddedNATsServer) WaitForServer()

type ErrGroupSeparateCtx

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

func NewErrGroupSeparateCtx

func NewErrGroupSeparateCtx() *ErrGroupSeparateCtx

func (*ErrGroupSeparateCtx) Go

func (egc *ErrGroupSeparateCtx) Go(ctx context.Context, funcs ...CtxErrFunc)

func (*ErrGroupSeparateCtx) Wait

func (egc *ErrGroupSeparateCtx) Wait() error

type ErrGroupSharedCtx

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

func NewErrGroupSharedCtx

func NewErrGroupSharedCtx(ctx context.Context, funcs ...CtxErrFunc) *ErrGroupSharedCtx

func (*ErrGroupSharedCtx) Go

func (egc *ErrGroupSharedCtx) Go(funcs ...CtxErrFunc)

func (*ErrGroupSharedCtx) Wait

func (egc *ErrGroupSharedCtx) Wait() error

type Float

type Float interface {
	~float32 | ~float64
}

type Integer

type Integer interface {
	~int | ~uint8 | ~int8 | ~uint16 | ~int16 | ~uint32 | ~int32 | ~uint64 | ~int64
}

type TxFn

type TxFn func(tx *sqlite.Conn) error

type TypedIdFunc

type TypedIdFunc[T protoreflect.ProtoMessage] func(T) string

type TypedKV

type TypedKV[T proto.Message] struct {
	// contains filtered or unexported fields
}

func UpsertTypedKV

func UpsertTypedKV[T protoreflect.ProtoMessage](js nats.JetStreamContext, cfg *nats.KeyValueConfig, newFn TypedNewFunc[T], idFn TypedIdFunc[T]) (*TypedKV[T], error)

func (*TypedKV[T]) All

func (tkv *TypedKV[T]) All() (out []T, err error)

func (*TypedKV[T]) Batch

func (tkv *TypedKV[T]) Batch(values ...T) (err error)

func (*TypedKV[T]) Delete

func (tkv *TypedKV[T]) Delete(value T) (err error)

func (*TypedKV[T]) DeleteKey

func (tkv *TypedKV[T]) DeleteKey(key string) (err error)

func (*TypedKV[T]) Get

func (t *TypedKV[T]) Get(key string) (T, uint64, error)

func (*TypedKV[T]) Keys

func (tkv *TypedKV[T]) Keys() ([]string, error)

func (*TypedKV[T]) Load

func (tkv *TypedKV[T]) Load(keys ...string) (loaded []T, err error)

func (*TypedKV[T]) Set

func (tkv *TypedKV[T]) Set(value T) (revision uint64, err error)

func (*TypedKV[T]) Update

func (tkv *TypedKV[T]) Update(value T, last uint64) (revision uint64, err error)

type TypedNewFunc

type TypedNewFunc[T protoreflect.ProtoMessage] func() T