utils

package

v2.3.0 Latest Latest Go to latest Published: Dec 12, 2025 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/unkeyed/sdks

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AsSecuritySource(security interface{}) func(context.Context) (interface{}, error)
func ConsumeRawBody(res *http.Response) ([]byte, error)
func Contains(slice []string, item string) bool
func GenerateURL(_ context.Context, serverURL, path string, pathParams interface{}, ...) (string, error)
func GetEnv(name, defaultValue string) string
func MarshalJSON(v interface{}, tag reflect.StructTag, topLevel bool) ([]byte, error)
func MatchContentType(contentType string, pattern string) bool
func MatchStatusCodes(expectedCodes []string, statusCode int) bool
func PopulateHeaders(_ context.Context, req *http.Request, headers interface{}, globals interface{})
func PopulateQueryParams(_ context.Context, req *http.Request, queryParams interface{}, ...) error
func PopulateSecurity(ctx context.Context, req *http.Request, ...) error
func PopulateSecurityFromEnv(security interface{}) bool
func ReplaceParameters(stringWithParams string, params map[string]string) string
func Retry(ctx context.Context, r Retries, operation func() (*http.Response, error)) (*http.Response, error)
func SerializeRequestBody(_ context.Context, request interface{}, nullable, optional bool, ...) (io.Reader, string, error)
func UnmarshalJSON(b []byte, v interface{}, tag reflect.StructTag, topLevel bool, ...) error
func UnmarshalJsonFromResponseBody(body io.Reader, out interface{}, tag string) error
func ValueFromEnvVar(envVar string, field interface{}) interface{}
type BackoffStrategydeprecated
type Retries
type RetryConfigdeprecated
type Timer
type UnionCandidate
- func PickBestUnionCandidate(candidates []UnionCandidate, rawJSON []byte) *UnionCandidate

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SerializationMethodToContentType = map[string]string{
		"json":      "application/json",
		"form":      "application/x-www-form-urlencoded",
		"multipart": "multipart/form-data",
		"raw":       "application/octet-stream",
		"string":    "text/plain",
	}
)

Functions ¶

func AsSecuritySource ¶

func AsSecuritySource(security interface{}) func(context.Context) (interface{}, error)

func ConsumeRawBody ¶

func ConsumeRawBody(res *http.Response) ([]byte, error)

func Contains ¶

func Contains(slice []string, item string) bool

func GenerateURL ¶

func GenerateURL(_ context.Context, serverURL, path string, pathParams interface{}, globals interface{}) (string, error)

func GetEnv ¶

func GetEnv(name, defaultValue string) string

GetEnv returns the value of the environment variable named by the key or the defaultValue if the environment variable is not set.

func MarshalJSON ¶

func MarshalJSON(v interface{}, tag reflect.StructTag, topLevel bool) ([]byte, error)

func MatchContentType ¶

func MatchContentType(contentType string, pattern string) bool

func MatchStatusCodes ¶

func MatchStatusCodes(expectedCodes []string, statusCode int) bool

func PopulateHeaders ¶

func PopulateHeaders(_ context.Context, req *http.Request, headers interface{}, globals interface{})

func PopulateQueryParams ¶

func PopulateQueryParams(_ context.Context, req *http.Request, queryParams interface{}, globals interface{}, allowEmptyValue map[string]struct{}) error

func PopulateSecurity ¶

func PopulateSecurity(ctx context.Context, req *http.Request, securitySource func(context.Context) (interface{}, error)) error

func PopulateSecurityFromEnv ¶

func PopulateSecurityFromEnv(security interface{}) bool

func ReplaceParameters ¶

func ReplaceParameters(stringWithParams string, params map[string]string) string

func Retry ¶

func Retry(ctx context.Context, r Retries, operation func() (*http.Response, error)) (*http.Response, error)

func SerializeRequestBody ¶

func SerializeRequestBody(_ context.Context, request interface{}, nullable, optional bool, requestFieldName, serializationMethod, tag string) (io.Reader, string, error)

func UnmarshalJSON ¶

func UnmarshalJSON(b []byte, v interface{}, tag reflect.StructTag, topLevel bool, requiredFields []string) error

func UnmarshalJsonFromResponseBody ¶

func UnmarshalJsonFromResponseBody(body io.Reader, out interface{}, tag string) error

func ValueFromEnvVar ¶

func ValueFromEnvVar(envVar string, field interface{}) interface{}

Types ¶

type BackoffStrategy deprecated

type BackoffStrategy = retry.BackoffStrategy

Deprecated: Use retry.BackoffStrategy instead.

type Retries ¶

type Retries struct {
	Config      *retry.Config
	StatusCodes []string
}

type RetryConfig deprecated

type RetryConfig = retry.Config

Deprecated: Use retry.Config instead.

type Timer ¶

type Timer interface {
	Start(duration time.Duration)
	Stop()
	C() <-chan time.Time
}

type UnionCandidate ¶ added in v2.2.0

type UnionCandidate struct {
	Matched              int // Count of matched fields (includes inexact)
	Inexact              int // Count of fields with unknown/unrecognized enum values
	Unmatched            int // Count of struct fields not found in raw JSON
	AdditionalProperties int // Count of fields captured by additionalProperties
	Type                 any // The union type enum value
	Value                any // The unmarshaled value
}

UnionCandidate represents a candidate type during union deserialization

func PickBestUnionCandidate ¶ added in v2.3.0

func PickBestUnionCandidate(candidates []UnionCandidate, rawJSON []byte) *UnionCandidate

PickBestUnionCandidate selects the best union type candidate according to `betterCandidate`

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL