float64_value.go

// -------------------------------------------------------------------- //
// !      DO NOT EDIT. This file is auto-generated from template      ! //
// -------------------------------------------------------------------- //
package supertypes

import (
	"context"
	"github.com/hashicorp/terraform-plugin-framework/attr"
	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)

// Ensure the implementation satisfies the expected interfaces.
var _ basetypes.Float64Valuable = Float64Value{}

type Float64Value struct {
	basetypes.Float64Value
}

func (v Float64Value) Equal(o attr.Value) bool {
	other, ok := o.(Float64Value)

	if !ok {
		return false
	}

	return v.Float64Value.Equal(other.Float64Value)
}

func (v Float64Value) Type(ctx context.Context) attr.Type {
	return Float64Type{
		Float64Type: v.Float64Value.Type(ctx).(basetypes.Float64Type),
	}
}

func NewFloat64Null() Float64Value {
	return Float64Value{
		Float64Value: basetypes.NewFloat64Null(),
	}
}

func NewFloat64Unknown() Float64Value {
	return Float64Value{
		Float64Value: basetypes.NewFloat64Unknown(),
	}
}

func NewFloat64Value(s float64) Float64Value {
	return Float64Value{
		Float64Value: basetypes.NewFloat64Value(s),
	}
}

func NewFloat64PointerValue(s *float64) Float64Value {
	return Float64Value{
		Float64Value: basetypes.NewFloat64PointerValue(s),
	}
}

// * CustomFunc

// Get returns the known Float64 value. If Float64 is null or unknown, returns 0.0.
func (v *Float64Value) Get() float64 {
	return v.Float64Value.ValueFloat64()
}

// GetPtr returns a pointer to the known int64 value, nil for a
// null value, or a pointer to 0 for an unknown value.
func (v *Float64Value) GetPtr() *float64 {
	return v.Float64Value.ValueFloat64Pointer()
}

// Set sets the Float64 value.
func (v *Float64Value) Set(s float64) {

	v.Float64Value = basetypes.NewFloat64Value(s)
}

// SetPtr sets a pointer to the Float64 value.
func (v *Float64Value) SetPtr(s *float64) {
	if s == nil {
		v.Float64Value = basetypes.NewFloat64Null()
		return
	}

	v.Float64Value = basetypes.NewFloat64PointerValue(s)
}

// SetFloat32 sets a converted float32 to float64 value.
func (v *Float64Value) SetFloat32(s float32) {
	v.Set(setFloatValue(s))
}

// SetFloat64 sets a float64 value. This is a same func as Set.
func (v *Float64Value) SetFloat64(s float64) {
	v.Set(s)
}

// SetFloat32Ptr sets a converted float32 to float64 pointer. If the pointer is nil, the value is set to null.
func (v *Float64Value) SetFloat32Ptr(s *float32) {
	if s == nil {
		v.Float64Value = basetypes.NewFloat64Null()
		return
	}

	v.Float64Value = basetypes.NewFloat64Value(setFloatValue(*s))
}

// SetFloat64Ptr sets a float64 pointer. This is a same func as SetPtr.
func (v *Float64Value) SetFloat64Ptr(s *float64) {
	v.SetPtr(s)
}

// GetFloat32 returns converted float64 to float32 value.
func (v *Float64Value) GetFloat32() float32 {
	return float32(v.Get())
}

// GetFloat64 returns the float64 value. This is a same func as Get.
func (v Float64Value) GetFloat64() float64 {
	return v.Get()
}

// GetFloat32Ptr returns a converted float64 to float32 pointer. If the value is null or unknown, nil is returned.
func (v Float64Value) GetFloat32Ptr() *float32 {
	if v.IsKnown() {
		s := float32(v.Get())
		return &s
	}

	return nil
}

// GetFloat64Ptr returns a float64 pointer. This is a same func as GetPtr. If the value is null or unknown, nil is returned.
func (v Float64Value) GetFloat64Ptr() *float64 {
	return v.GetPtr()
}

type floatValues interface {
	float32 | float64
}

func setFloatValue[T floatValues](s T) float64 {
	return float64(s)
}

// SetNull sets the Float64 value to null.
func (v *Float64Value) SetNull() {
	v.Float64Value = basetypes.NewFloat64Null()
}

// SetUnknown sets the Float64 value to unknown.
func (v *Float64Value) SetUnknown() {
	v.Float64Value = basetypes.NewFloat64Unknown()
}

// IsKnown returns true if the value is not null and not unknown.
func (v Float64Value) IsKnown() bool {
	return !v.Float64Value.IsNull() && !v.Float64Value.IsUnknown()
}