typeutils

package
v0.16.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 23, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BoolFromMap added in v0.16.2 

func BoolFromMap(m map[string]any, key string) types.Bool

BoolFromMap extracts a bool from a map[string]any by key, returning types.BoolNull() when the map is nil, the key is absent, or the value is not a bool.

func ConvertSettingsKeyToTFFieldKey added in v0.15.2 

func ConvertSettingsKeyToTFFieldKey(settingKey string) string

ConvertSettingsKeyToTFFieldKey maps a dotted Elasticsearch settings key to the Terraform attribute name used in flattened blocks (dots → underscores).

func Deref added in v0.15.0 

func Deref[T any](value *T) T

Deref returns the value referenced by the given pointer. If the pointer is nil, a zero value is returned.

func DerefOrElse added in v0.15.0 

func DerefOrElse(val *string, def string) string

DerefOrElse returns the value pointed to by val if it is non-nil and non-empty, otherwise it returns def. It is the inverse of NonEmptyStringPtr.

func ElasticDateTimeToMillis added in v0.16.2 

func ElasticDateTimeToMillis(v any) (int64, bool)

ElasticDateTimeToMillis converts any Elastic DateTime representation to Unix milliseconds. Handles float64, int64, int, uint64, json.Number, and RFC3339 strings. Returns (0, false) for nil, empty, or unparseable values.

estypes.DateTime is defined as `type DateTime any` (a named interface); its concrete value is unwrapped by Go's interface-boxing rules before the type switch, so DateTime(float64) is handled by the float64 case and DateTime(string) by the string case.

func ElasticDateTimeToStringValue added in v0.16.2 

func ElasticDateTimeToStringValue(v any) types.String

ElasticDateTimeToStringValue converts an Elastic DateTime (passed as any) to a types.String in ISO 8601 format. Returns types.StringNull() for nil, zero, empty, or unparseable values. Accepts any value; callers typically pass estypes.DateTime which is `type DateTime any`.

func ElasticsearchDurationToString added in v0.16.2 

func ElasticsearchDurationToString(d estypes.Duration) types.String

ElasticsearchDurationToString converts an estypes.Duration to a Terraform types.String. Returns types.StringNull() when d is nil.

func EnsureTypedList added in v0.14.0 

func EnsureTypedList(ctx context.Context, list types.List, elemType attr.Type) types.List

EnsureTypedList converts untyped zero-value lists to properly typed null lists. This is commonly needed during import operations where the framework may create untyped lists with DynamicPseudoType elements, which causes type conversion errors. If the list already has a proper type, it is returned unchanged.

func FlattenMap added in v0.15.0 

func FlattenMap(m map[string]any) map[string]any

FlattenMap recursively flattens a nested map into a single-level map with dot-separated keys. For example, {"index": {"key": 1}} becomes {"index.key": 1}.

func FlipMap added in v0.15.0 

func FlipMap[K comparable, V comparable](m map[K]V) map[V]K

FlipMap returns a new map with keys and values swapped.

func Float32PointerToFloat64Value added in v0.16.2 

func Float32PointerToFloat64Value(v *float32) types.Float64

Float32PointerToFloat64Value converts a *float32 to a types.Float64, returning types.Float64Null() when the pointer is nil.

func Float32Ptr added in v0.15.0 

func Float32Ptr(v float64) *float32

Float32Ptr converts a float64 to a *float32.

func Float64FromMap added in v0.16.2 

func Float64FromMap(m map[string]any, key string) types.Float64

Float64FromMap extracts a float64 from a map[string]any by key, returning types.Float64Null() when the map is nil, the key is absent, or the value is not a float64/int/int64.

func Float64PointerValue added in v0.15.0 

func Float64PointerValue(value types.Float64) *float64

Float64PointerValue returns nil if unknown, otherwise the same as value.ValueFloat64Pointer().

func FormatStrictDateTime added in v0.15.0 

func FormatStrictDateTime(t time.Time) string

FormatStrictDateTime formats a time.Time as ISO 8601 strict date-time with milliseconds.

func Int64Pointer added in v0.16.2 

func Int64Pointer(v types.Int64) *int64

Int64Pointer returns a pointer to the int64 value when set, or nil when null or unknown.

func IntPointerToInt64Value added in v0.16.2 

func IntPointerToInt64Value(v *int) types.Int64

IntPointerToInt64Value converts a *int to a types.Int64, returning types.Int64Null() when the pointer is nil.

func IsEmpty added in v0.15.0 

func IsEmpty(v any) bool

IsEmpty reports whether v is a zero-like value: zero number, blank string, empty slice/map, or nil.

func IsEmptyJSONObject added in v0.16.2 

func IsEmptyJSONObject(s string) bool

IsEmptyJSONObject reports whether s is a semantically-empty JSON object — either whitespace-only, the literal `{}`, or any JSON object that unmarshals to a zero-length, non-nil map. It returns false for non-empty objects, arrays, scalars, the JSON literal `null`, and invalid JSON.

func IsKnown added in v0.14.3 

func IsKnown(value attr.Value) bool

func Itol added in v0.15.0 

func Itol(value *int) *int64

Itol converts *int to *int64.

func JSONBytesEqual added in v0.15.0 

func JSONBytesEqual(a, b []byte) (bool, error)

JSONBytesEqual reports whether the JSON in two byte slices is semantically equivalent.

func ListToStrings added in v0.16.2 

func ListToStrings(list types.List) []string

ListToStrings extracts a []string from a types.List of string elements. Null or unknown lists return nil.

func ListTypeAs added in v0.14.3 

func ListTypeAs[T any](ctx context.Context, value types.List, p path.Path, diags *diag.Diagnostics) []T

ListTypeAs converts a types.List into a tfsdk aware []T.

func ListTypeToMap added in v0.14.3 

func ListTypeToMap[T1 any, T2 any](ctx context.Context, value types.List, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta ListMeta) (key string, elem T2)) map[string]T2

ListTypeToMap converts a types.List first into a tfsdk aware []T1 and transforms the result into a map[string]T2.

func ListTypeToSlice added in v0.14.3 

func ListTypeToSlice[T1 any, T2 any](ctx context.Context, value types.List, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta ListMeta) T2) []T2

ListTypeToSlice converts a types.List first into a tfsdk aware []T1 and transforms the result into a []T2.

func ListTypeToSliceString added in v0.14.3 

func ListTypeToSliceString(ctx context.Context, value types.List, p path.Path, diags *diag.Diagnostics) []string

ListTypeToSliceString converts a types.List into a []string. This is a shorthand ListTypeToSlice helper for strings.

func ListValueFrom added in v0.14.3 

func ListValueFrom[T any](ctx context.Context, value []T, elemType attr.Type, p path.Path, diags *diag.Diagnostics) types.List

ListValueFrom converts a tfsdk aware []T to a types.List.

func Ltoi added in v0.15.0 

func Ltoi(value *int64) *int

Ltoi converts *int64 to *int.

func MapRef added in v0.15.0 

func MapRef[K comparable, T any, M ~map[K]T](value M) *M

MapRef takes the reference of the given map value. If the value is nil, it returns nil rather than a pointer to nil.

func MapToMapType added in v0.14.3 

func MapToMapType[T1 any, T2 any](ctx context.Context, value map[string]T1, elemType attr.Type, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta MapMeta) T2) types.Map

MapToMapType converts a tfsdk naive map[string]T1 into an types.Map of map[string]T2. This handles both structs and simple types to attr.Values.

func MapTypeAs added in v0.14.3 

func MapTypeAs[T any](ctx context.Context, value types.Map, p path.Path, diags *diag.Diagnostics) map[string]T

MapTypeAs converts a types.Map into a tfsdk aware map[string]T.

func MapTypeToMap added in v0.14.3 

func MapTypeToMap[T1 any, T2 any](ctx context.Context, value types.Map, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta MapMeta) T2) map[string]T2

MapTypeToMap converts a types.Map first into a tfsdk aware map[string]T1 and transforms the result into a map[string]T2.

func MapValueFrom added in v0.14.3 

func MapValueFrom[T any](ctx context.Context, value map[string]T, elemType attr.Type, p path.Path, diags *diag.Diagnostics) types.Map

MapValueFrom converts a tfsdk aware map[string]T to a types.Map.

func MarshalToNormalized added in v0.16.2 

func MarshalToNormalized(v any, p path.Path, diags *diag.Diagnostics) jsontypes.Normalized

MarshalToNormalized marshals v to a jsontypes.Normalized value.

  • If v is nil, or a nil pointer/map/slice/channel/function stored inside an interface{}, it returns jsontypes.NewNormalizedNull().
  • On a marshal error it appends an attribute error at p to diags and returns jsontypes.NewNormalizedNull().

func NonEmptyListOrDefault added in v0.13.1 

func NonEmptyListOrDefault[T any](ctx context.Context, original types.List, elemType attr.Type, slice []T) (types.List, diag.Diagnostics)

NonEmptyListOrDefault returns the original list if slice is empty, otherwise converts slice into a types.List.

func NonEmptySetOrDefault added in v0.13.1 

func NonEmptySetOrDefault[T any](ctx context.Context, original types.Set, elemType attr.Type, slice []T) (types.Set, diag.Diagnostics)

NonEmptySetOrDefault returns the original set if slice is empty, otherwise converts slice into a types.Set.

func NonEmptyStringOrNull added in v0.16.2 

func NonEmptyStringOrNull(s *string) types.String

NonEmptyStringOrNull returns types.StringValue(*s) when s is non-nil and non-empty, and types.StringNull() otherwise. Use for API fields that use an empty string to signal absence.

func NonEmptyStringPtr added in v0.15.0 

func NonEmptyStringPtr(s string) *string

NonEmptyStringPtr returns a pointer to s, or nil if s is empty.

func NonEmptyStringishPointerValue 

func NonEmptyStringishPointerValue[T ~string](ptr *T) types.String

func NonEmptyStringishValue 

func NonEmptyStringishValue[T ~string](value T) types.String

func NonNilSlice added in v0.15.0 

func NonNilSlice[T any](s []T) []T

NonNilSlice returns an empty slice if s is nil. Guarantees that json.Marshal and terraform parameters will not treat the empty slice as null.

func NonZero added in v0.16.2 

func NonZero[T comparable](v T, fallback T) T

NonZero returns v if it is not the zero value for T; otherwise it returns fallback.

func NormalizeJSONScalar added in v0.15.2 

func NormalizeJSONScalar(v any) any

NormalizeJSONScalar recursively walks a decoded JSON value and converts string-encoded JSON booleans and null back to their native Go types. "true" → bool(true), "false" → bool(false), "null" → nil. All other values are returned unchanged.

func NormalizedTypeToMap added in v0.14.3 

func NormalizedTypeToMap[T any](value jsontypes.Normalized, p path.Path, diags *diag.Diagnostics) map[string]T

NormalizedTypeToMap unmarshals a jsontypes.Normalized to a map[string]T.

func ObjectTypeAs added in v0.14.3 

func ObjectTypeAs[T any](ctx context.Context, value types.Object, p path.Path, diags *diag.Diagnostics) *T

ObjectTypeAs converts a types.Object into a tfsdk aware T.

func ObjectTypeToStruct added in v0.14.3 

func ObjectTypeToStruct[T1 any, T2 any](ctx context.Context, value types.Object, p path.Path, diags *diag.Diagnostics, transformee func(item T1, meta ObjectMeta) T2) *T2

ObjectTypeToStruct converts a types.Object first into a tfsdk aware T1 and transforms the result into a T2.

func ObjectValueFrom added in v0.14.3 

func ObjectValueFrom[T any](ctx context.Context, value *T, attrTypes map[string]attr.Type, p path.Path, diags *diag.Diagnostics) types.Object

ObjectValueFrom converts a tfsdk aware T to a types.Object.

func OptionalBool added in v0.16.1 

func OptionalBool(value types.Bool) *bool

OptionalBool returns a pointer to the bool value when set, or nil when null or unknown.

func OptionalInt added in v0.16.2 

func OptionalInt(value types.Int64) *int

OptionalInt returns a pointer to the int value when set, or nil when null or unknown. Use when the target API field expects *int rather than *int64.

func OptionalString added in v0.16.1 

func OptionalString(value types.String) *string

OptionalString returns a non-nil pointer only when the value is known and non-empty. Returns nil when the value is null, unknown, or an empty string. Use for optional API string fields where empty string and absent are equivalent.

func PointerInterfaceMapFromAnyMap added in v0.15.0 

func PointerInterfaceMapFromAnyMap(input map[string]any) map[string]*any

PointerInterfaceMapFromAnyMap converts a map[string]any to map[string]*any by taking pointers to each value. This is needed when constructing API request bodies that require pointer values.

func SetBoolInMap added in v0.16.2 

func SetBoolInMap(m map[string]any, key string, val types.Bool)

SetBoolInMap sets a bool field in the map if the value is known and non-null.

func SetStringInMap added in v0.16.2 

func SetStringInMap(m map[string]any, key string, val types.String)

SetStringInMap sets a string field in the map if the value is known and non-null.

func SetTypeAs added in v0.14.3 

func SetTypeAs[T any](ctx context.Context, value types.Set, p path.Path, diags *diag.Diagnostics) []T

SetTypeAs converts a types.Set into a tfsdk aware []T.

func SetValueFrom added in v0.14.3 

func SetValueFrom[T any](ctx context.Context, value []T, elemType attr.Type, p path.Path, diags *diag.Diagnostics) types.Set

SetValueFrom converts a tfsdk aware []T to a types.Set.

func SliceNilIfEmpty added in v0.15.0 

func SliceNilIfEmpty[T any, S ~[]T](value S) *S

SliceNilIfEmpty takes the reference of the given slice value. If the value is nil or empty, it returns nil rather than a pointer to an empty slice.

func SliceRef added in v0.15.0 

func SliceRef[T any, S ~[]T](value S) *S

SliceRef takes the reference of the given slice value. If the value is nil, it returns nil rather than a pointer to nil.

func SliceToListType added in v0.14.3 

func SliceToListType[T1 any, T2 any](ctx context.Context, value []T1, elemType attr.Type, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta ListMeta) T2) types.List

SliceToListType converts a tfsdk naive []T1 into an types.List of []T2. This handles both structs and simple types to attr.Values.

func SliceToListTypeString added in v0.14.3 

func SliceToListTypeString(ctx context.Context, value []string, p path.Path, diags *diag.Diagnostics) types.List

SliceToListTypeString converts a tfsdk naive []string into a types.List. This is a shorthand SliceToListType helper for strings.

func StringFromMap added in v0.16.2 

func StringFromMap(m map[string]any, key string) types.String

StringFromMap extracts a string from a map[string]any by key, returning types.StringNull() when the map is nil, the key is absent, or the value is not a string.

func StringSetElements added in v0.16.2 

func StringSetElements(set types.Set, diags *diag.Diagnostics) []string

StringSetElements extracts the string values from a types.Set of strings without requiring a context.Context. Returns nil for null/unknown sets and appends an error diagnostic for non-string or unknown elements.

func StringSetOrNull added in v0.16.2 

func StringSetOrNull(ctx context.Context, src []string) (types.Set, diag.Diagnostics)

StringSetOrNull converts a []string to a types.Set. Returns a null string set when src is empty so that unset attributes are stored as null in state.

func StringSliceValue added in v0.16.2 

func StringSliceValue(v []string) []types.String

StringSliceValue converts []string to []types.String.

func StringToHash added in v0.15.0 

func StringToHash(s string) (*string, error)

StringToHash computes a SHA-1 hash of s and returns the hex-encoded result as a pointer.

func StringishPointerValue 

func StringishPointerValue[T ~string](ptr *T) types.String

StringishPointerValue converts a pointer to a string-like type to a Terraform types.String value.

func StringishToPointer added in v0.16.1 

func StringishToPointer[T ~string](v types.String) *T

StringishToPointer converts a types.String to a typed string-enum pointer, returning nil for null, unknown, or empty-string values.

func StringishValue 

func StringishValue[T ~string](value T) types.String

StringishValue converts a value of any string-like type T to a Terraform types.String.

func StringsToList added in v0.16.2 

func StringsToList(strs []string) types.List

StringsToList converts a []string to a types.List of string elements. The result is always valid; an empty slice produces an empty list.

func StructToObjectType added in v0.14.3 

func StructToObjectType[T1 any, T2 any](
	ctx context.Context,
	value *T1,
	attrTypes map[string]attr.Type,
	p path.Path,
	diags *diag.Diagnostics,
	transformee func(item T1, meta ObjectMeta) T2,
) types.Object

StructToObjectType converts a tfsdk naive T1 into an types.Object of T2.

func TimeToStringValue added in v0.15.0 

func TimeToStringValue(t time.Time) types.String

TimeToStringValue formats a time.Time to ISO 8601 format and returns a types.StringValue.

func TransformMap added in v0.14.3 

func TransformMap[T1 any, T2 any](_ context.Context, value map[string]T1, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta MapMeta) T2) map[string]T2

TransformMap converts map[string]T1 to map[string]T2 via the iteratee.

func TransformMapToSlice added in v0.14.3 

func TransformMapToSlice[T1 any, T2 any](_ context.Context, value map[string]T1, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta MapMeta) T2) []T2

TransformMapToSlice converts map[string]T1 to []T2 via the iteratee.

func TransformObject added in v0.14.3 

func TransformObject[T1 any, T2 any](_ context.Context, value *T1, p path.Path, diags *diag.Diagnostics, transformee func(item T1, meta ObjectMeta) T2) *T2

TransformObject converts T1 to T2 via the transformee.

func TransformSlice added in v0.14.3 

func TransformSlice[T1 any, T2 any](_ context.Context, value []T1, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta ListMeta) T2) []T2

TransformSlice converts []T1 to []T2 via the iteratee.

func TransformSliceToMap added in v0.14.3 

func TransformSliceToMap[T1 any, T2 any](_ context.Context, value []T1, p path.Path, diags *diag.Diagnostics, iteratee func(item T1, meta ListMeta) (key string, elem T2)) map[string]T2

TransformSliceToMap converts []T1 to map[string]T2 via the iteratee.

func ValueStringPointer added in v0.14.3 

func ValueStringPointer(value types.String) *string

ValueStringPointer returns nil when the value is unknown or null, and &"" when empty. Use for computed optional fields that must distinguish null from empty string at the API level. For fields where empty string means "not set", prefer OptionalString instead.

func ValueStringSlice added in v0.16.2 

func ValueStringSlice(v []types.String) []string

ValueStringSlice converts []types.String to []string.

func WalkJSON added in v0.16.2 

func WalkJSON(v any, leaf func(any) any) any

WalkJSON recursively walks a decoded JSON value tree, applying leaf to every non-container node. Container nodes (map[string]any and []any) are always traversed. If leaf is nil, non-container values are returned unchanged.

Types

type Elementable added in v0.14.3 

type Elementable interface {
	attr.Value
	ElementsAs(ctx context.Context, target any, allowUnhandled bool) diag.Diagnostics
}

type ListMeta added in v0.14.3 

type ListMeta struct {
	Index int
	Path  path.Path
	Diags *diag.Diagnostics
}

type MapMeta added in v0.14.3 

type MapMeta struct {
	Key   string
	Path  path.Path
	Diags *diag.Diagnostics
}

type ObjectMeta added in v0.14.3 

type ObjectMeta struct {
	Path  path.Path
	Diags *diag.Diagnostics
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.