helpers

Documentation

Index

• func CallFunctionFromJson(f Callable, jsonArgs interface{}) ([]reflect.Value, error)
• func FillStructFromKV(kv map[string]string, v interface{}) error
• func GetFunctionParametersJsonSchema(reflector *jsonschema.Reflector, f Callable) (*jsonschema.Schema, error)
• func ParseKV(s string) map[string]string
• type Callable
• type Nothing
• type Result
  • func NewErrorResult[T any](err error) Result[T]
  • func NewResult[T any](value T, err error) Result[T]
  • func NewValueResult[T any](value T) Result[T]
  • func (r Result[T]) Error() error
  • func (r Result[T]) MarshalZerologObject(e *zerolog.Event)
  • func (r Result[T]) Ok() bool
  • func (r Result[T]) String() string
  • func (r Result[T]) Unwrap() T
  • func (r Result[T]) Value() (T, error)
  • func (r Result[T]) ValueOr(v T) T
• type ResultSlice
  • func ToResultSlice[T any](results []Result[T]) ResultSlice[T]
  • func (rs ResultSlice[T]) MarshalZerologArray(a *zerolog.Array)
• type SimplifiedJsonSchema
  • func GetSimplifiedFunctionParametersJsonSchema(reflector *jsonschema.Reflector, f Callable) (*SimplifiedJsonSchema, error)
• type SimplifiedJsonSchemaProperty

Functions

func CallFunctionFromJson

func CallFunctionFromJson(f Callable, jsonArgs interface{}) ([]reflect.Value, error)

CallFunctionFromJson calls a function with arguments provided as JSON TODO(manuel, 2024-01-12) make this take a ctx

func FillStructFromKV

func FillStructFromKV(kv map[string]string, v interface{}) error

func GetFunctionParametersJsonSchema

func GetFunctionParametersJsonSchema(reflector *jsonschema.Reflector, f Callable) (*jsonschema.Schema, error)

GetFunctionParametersJsonSchema generates a JSON Schema for the arguments of the given function

func ParseKV

func ParseKV(s string) map[string]string

ParseKV transforms a simple format. Each line has a key value pair separated by :. Empty lines are ignored

Types

type Callable

type Callable interface{}

Callable is a type representing any callable function

type Nothing

type Nothing struct{}

type Result

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

func NewErrorResult

func NewErrorResult[T any](err error) Result[T]

func NewResult

func NewResult[T any](value T, err error) Result[T]

func NewValueResult

func NewValueResult[T any](value T) Result[T]

func (Result[T]) Error

func (r Result[T]) Error() error

func (Result[T]) MarshalZerologObject

func (r Result[T]) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler

func (Result[T]) Ok

func (r Result[T]) Ok() bool

func (Result[T]) String

func (r Result[T]) String() string

func (Result[T]) Unwrap

func (r Result[T]) Unwrap() T

func (Result[T]) Value

func (r Result[T]) Value() (T, error)

func (Result[T]) ValueOr

func (r Result[T]) ValueOr(v T) T

type ResultSlice

type ResultSlice[T any] []Result[T]

ResultSlice is a slice of Results that can be marshaled by zerolog

func ToResultSlice

func ToResultSlice[T any](results []Result[T]) ResultSlice[T]

ToResultSlice converts a slice of Results to a ResultSlice for logging

func (ResultSlice[T]) MarshalZerologArray

func (rs ResultSlice[T]) MarshalZerologArray(a *zerolog.Array)

MarshalZerologArray implements zerolog.LogArrayMarshaler

type SimplifiedJsonSchema

type SimplifiedJsonSchema struct {
	Type        string                                   `json:"type"`
	Description string                                   `json:"description,omitempty"`
	Properties  map[string]*SimplifiedJsonSchemaProperty `json:"properties"`
	Required    []string                                 `json:"required,omitempty"`
}

SimplifiedJsonSchema represents a simplified root JSON Schema

func GetSimplifiedFunctionParametersJsonSchema

func GetSimplifiedFunctionParametersJsonSchema(reflector *jsonschema.Reflector, f Callable) (*SimplifiedJsonSchema, error)

GetSimplifiedFunctionParametersJsonSchema generates a simplified JSON Schema for the arguments of the given function

type SimplifiedJsonSchemaProperty

type SimplifiedJsonSchemaProperty struct {
	Type        string                                   `json:"type"`
	Description string                                   `json:"description,omitempty"`
	Required    bool                                     `json:"-"`
	Properties  map[string]*SimplifiedJsonSchemaProperty `json:"properties,omitempty"`
	Items       *SimplifiedJsonSchemaProperty            `json:"items,omitempty"`
}

SimplifiedJsonSchemaProperty represents a simplified property in the JSON Schema