util

Documentation

Index

• Variables
• func BindContext[A any](ctx context.Context, f func(context.Context) A) func() A
• func BindContext2[A, B any](ctx context.Context, f func(context.Context) (A, B)) func() (A, B)
• func DecodeStruct[T any](input interface{}) (*T, error)
• func DeepCopy[T any](in *T) *T
• func DeepCopyInto[T any](out, in *T)
• func DialProtocol(ctx context.Context, addr string) (net.Conn, error)
• func FieldByName[T proto.Message](name string) protoreflect.FieldDescriptor
• func FieldIndexByName[T proto.Message](name string) int
• func GenerateRandomString(length int) []byte
• func HashString(s string) uint64
• func HashStrings(strings []string) string
• func Humanize(i any) (string, error)
• func Humanize1024(i any) (string, error)
• func Indexed[T any, U any](f func(T) U) func(T, int) U
• func IsInterfaceNil(i interface{}) bool
• func LoadClientMTLSConfig(certs *v1beta1.MTLSSpec) (*tls.Config, error)
• func LoadServingCertBundle(certsSpec v1beta1.CertsSpec) (*tls.Certificate, *x509.CertPool, error)
• func Must[T any](t T, err ...error) T
• func NewMessage[T proto.Message]() T
• func NewProtocolListener(addr string) (net.Listener, error)
• func ParsePEMEncodedCert(data []byte) (*x509.Certificate, error)
• func ParsePEMEncodedCertChain(chain []byte) ([]*x509.Certificate, error)
• func ProtoClone[T proto.Message](msg T) T
• func ReadString(r io.Reader) string
• func RemoveFirstOccurence[S ~[]T, T comparable](items S, remove T) S
• func ReplaceFirstOccurrence[S ~[]T, T comparable](items S, old T, new T) S
• func ServeHandler(ctx context.Context, handler http.Handler, listener net.Listener) error
• func SplitChunksWithLimit(request *prompb.WriteRequest, limit WriteLimit) ([]*prompb.WriteRequest, error)
• func StatusCode(err error) codes.Code
• func StatusError(code codes.Code) error
• func WaitAll(ctx context.Context, ca context.CancelFunc, channels ...<-chan error) error
• type DelimiterCodec
  • func NewDelimiterCodec(key string, delimiter string) DelimiterCodec
  • func (d DelimiterCodec) Decode(s string) []string
  • func (d DelimiterCodec) Encode(ids []string) string
  • func (d DelimiterCodec) Key() string
• type Initializer
  • func (i *Initializer) InitOnce(f func())
  • func (i *Initializer) Initialized() bool
  • func (i *Initializer) WaitForInit()
  • func (i *Initializer) WaitForInitContext(ctx context.Context) error
• type LockMap
  • func NewLockMap[K comparable, L locker[T], T any]() LockMap[K, L]
• type MultiErrGroup
  • func (i *MultiErrGroup) Add(tasks int)
  • func (i *MultiErrGroup) Done()
  • func (i *MultiErrGroup) Error() error
  • func (i *MultiErrGroup) Errors() []error
  • func (i *MultiErrGroup) Go(fn func() error)
  • func (i *MultiErrGroup) Wait()
• type ServicePack
  • func PackService[T any](desc *grpc.ServiceDesc, impl T) ServicePack[T]
  • func (s ServicePack[T]) Unpack() (*grpc.ServiceDesc, any)
• type ServicePackInterface
• type WriteLimit
  • func DefaultWriteLimit() WriteLimit

Variables

var ErrUnsupportedProtocolScheme = errors.New("unsupported protocol scheme")

Functions

func BindContext

func BindContext[A any](ctx context.Context, f func(context.Context) A) func() A

func BindContext2

func BindContext2[A, B any](ctx context.Context, f func(context.Context) (A, B)) func() (A, B)

func DecodeStruct

func DecodeStruct[T any](input interface{}) (*T, error)

func DeepCopy

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

func DeepCopyInto

func DeepCopyInto[T any](out, in *T)

func DialProtocol

func DialProtocol(ctx context.Context, addr string) (net.Conn, error)

func FieldByName

func FieldByName[T proto.Message](name string) protoreflect.FieldDescriptor

func FieldIndexByName

func FieldIndexByName[T proto.Message](name string) int

func GenerateRandomString

func GenerateRandomString(length int) []byte

func HashString

func HashString(s string) uint64

func HashStrings

func HashStrings(strings []string) string

func Humanize

func Humanize(i any) (string, error)

func Humanize1024

func Humanize1024(i any) (string, error)

func Indexed

func Indexed[T any, U any](f func(T) U) func(T, int) U

Used with lo.Map to wrap functions that do not take an index argument

func IsInterfaceNil

func IsInterfaceNil(i interface{}) bool

func LoadClientMTLSConfig

func LoadClientMTLSConfig(certs *v1beta1.MTLSSpec) (*tls.Config, error)

func LoadServingCertBundle

func LoadServingCertBundle(certsSpec v1beta1.CertsSpec) (*tls.Certificate, *x509.CertPool, error)

func Must

func Must[T any](t T, err ...error) T

func NewMessage

func NewMessage[T proto.Message]() T

func NewProtocolListener

func NewProtocolListener(addr string) (net.Listener, error)

func ParsePEMEncodedCert

func ParsePEMEncodedCert(data []byte) (*x509.Certificate, error)

func ParsePEMEncodedCertChain

func ParsePEMEncodedCertChain(chain []byte) ([]*x509.Certificate, error)

func ProtoClone

func ProtoClone[T proto.Message](msg T) T

func ReadString

func ReadString(r io.Reader) string

func RemoveFirstOccurence

func RemoveFirstOccurence[S ~[]T, T comparable](items S, remove T) S

func ReplaceFirstOccurrence

func ReplaceFirstOccurrence[S ~[]T, T comparable](items S, old T, new T) S

func ServeHandler

func ServeHandler(ctx context.Context, handler http.Handler, listener net.Listener) error

ServeHandler serves a http.Handler with the given listener. If the context is canceled, the server will be closed.

func SplitChunksWithLimit

func SplitChunksWithLimit(request *prompb.WriteRequest, limit WriteLimit) ([]*prompb.WriteRequest, error)

func StatusCode

func StatusCode(err error) codes.Code

Like status.Code(), but supports wrapped errors.

func StatusError

func StatusError(code codes.Code) error

func WaitAll

func WaitAll(ctx context.Context, ca context.CancelFunc, channels ...<-chan error) error

WaitAll waits for all the given channels to be closed, under the following rules: 1. The lifetime of the task represented by each channel is directly tied to the provided context. 2. If a task exits with an error before the context is canceled, the context should be canceled. 3. If a task exits successfully, the context should not be canceled and other tasks should continue to run.

Types

type DelimiterCodec

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

Implements rbac.Codec

func NewDelimiterCodec

func NewDelimiterCodec(key string, delimiter string) DelimiterCodec

func (DelimiterCodec) Decode

func (d DelimiterCodec) Decode(s string) []string

func (DelimiterCodec) Encode

func (d DelimiterCodec) Encode(ids []string) string

func (DelimiterCodec) Key

func (d DelimiterCodec) Key() string

type Initializer

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

func (*Initializer) InitOnce

func (i *Initializer) InitOnce(f func())

func (*Initializer) Initialized

func (i *Initializer) Initialized() bool

func (*Initializer) WaitForInit

func (i *Initializer) WaitForInit()

func (*Initializer) WaitForInitContext

func (i *Initializer) WaitForInitContext(ctx context.Context) error

type LockMap

type LockMap[K comparable, L sync.Locker] interface {
	Get(key K) L
	Delete(key K)
}

func NewLockMap

func NewLockMap[K comparable, L locker[T], T any]() LockMap[K, L]

type MultiErrGroup

type MultiErrGroup struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

tasks := []func() error{/* */}

for _, task := range tasks {
	eg.Go(func() error {
	return task()
	}
}

eg.Wait()

if err := eg.Error(); err != nil {
	// handle error
}

func (*MultiErrGroup) Add

func (i *MultiErrGroup) Add(tasks int)

func (*MultiErrGroup) Done

func (i *MultiErrGroup) Done()

func (*MultiErrGroup) Error

func (i *MultiErrGroup) Error() error

func (*MultiErrGroup) Errors

func (i *MultiErrGroup) Errors() []error

func (*MultiErrGroup) Go

func (i *MultiErrGroup) Go(fn func() error)

func (*MultiErrGroup) Wait

func (i *MultiErrGroup) Wait()

type ServicePack

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

func PackService

func PackService[T any](desc *grpc.ServiceDesc, impl T) ServicePack[T]

func (ServicePack[T]) Unpack

func (s ServicePack[T]) Unpack() (*grpc.ServiceDesc, any)

type ServicePackInterface

type ServicePackInterface interface {
	Unpack() (*grpc.ServiceDesc, any)
}

type WriteLimit

type WriteLimit struct {
	// GrpcMaxBytes is the maximum siz of a message that can be sent over the grpc connection.
	GrpcMaxBytes int

	// CortexIngestionRateLimit is the maximum number of samples that can be sent to cortex per second.
	CortexIngestionRateLimit int
}

func DefaultWriteLimit

func DefaultWriteLimit() WriteLimit