Float32 Type
Tip
Use Int32 Type for 32-bit integer numbers. Use Number Attribute for arbitrary precision numbers.
Float32 types store a 32-bit floating point number.
By default, float32 from schema (configuration, plan, and state) data are represented in the framework by types.Float32Type
and its associated value storage type of types.Float32
. These types fully support Terraform's type system concepts that cannot be represented in Go built-in types, such as *float32
. Framework types can be extended by provider code or shared libraries to provide specific use case functionality.
Schema Definitions
Use one of the following attribute types to directly add a float32 value to a schema or nested attribute type:
Schema Type | Attribute Type |
---|---|
Data Source | schema.Float32Attribute |
Provider | schema.Float32Attribute |
Resource | schema.Float32Attribute |
Ephemeral Resource | schema.Float32Attribute |
If the float32 value should be the element type of a collection attribute type, set the ElemType
field to types.Float32Type
or the appropriate custom type.
If the float32 value should be a value type of an object attribute type, set the AttrTypes
map value to types.Float32Type
or the appropriate custom type.
Accessing Values
Tip
Review the attribute documentation to understand how schema-based data gets mapped into accessible values, such as a types.Float32
in this case.
Access types.Float32
information via the following methods:
(types.Float32).IsNull() bool
: Returns true if the float32 is null.(types.Float32).IsUnknown() bool
: Returns true if the float32 is unknown.(types.Float32).ValueFloat32() float32
: Returns the known float32, or0.0
if null or unknown.(types.Float32).ValueFloat32Pointer() *float32
: Returns a float32 pointer to a known value,nil
if null, or a pointer to0.0
if unknown.
In this example, a float32 value is checked for being null or unknown value first, before accessing its known value:
Setting Values
Call one of the following to create a types.Float32
value:
types.Float32Null()
: A null float32 value.types.Float32Unknown()
: An unknown float32 value.types.Float32Value(float32)
: A known value.types.Float32PointerValue(*float32)
: A known value.
In this example, a known float32 value is created:
Otherwise, for certain framework functionality that does not require types
implementations directly, such as:
(tfsdk.State).SetAttribute()
types.ListValueFrom()
types.MapValueFrom()
types.ObjectValueFrom()
types.SetValueFrom()
Numbers can be automatically converted from the following Go types, pointers to these types, or any aliases of these types, such type MyNumber int
:
int
,int8
,int16
,int32
,int64
uint
,uint8
,uint16
,uint32
,uint64
float32
,float64
*big.Int
,*big.Float
An error will be returned if the value of the number cannot be stored in the numeric type supplied because of an overflow or other loss of precision.
In this example, a float32
is directly used to set a float32 attribute value:
In this example, a types.List
of types.Float32
is created from a []float32
:
Extending
The framework supports extending its base type implementations with custom types. These can adjust expected provider code usage depending on their implementation.