Float64 Function Return
Tip
Use Int64 Return for 64-bit integer numbers. Use Number Return for arbitrary precision numbers.
Float64 function return expects a 64-bit floating point number value from function logic. Set values in function logic with the Go built-in float64
type, Go built-in *float64
type, or the framework float64 type.
Function Definition
Use the function.Float64Return
type in the function definition.
In this example, a function definition includes a float64 return:
Custom Types
You may want to build your own data value and type implementations to allow your provider to combine validation and other behaviors into a reusable bundle. This helps avoid duplication and ensures consistency. These implementations use the CustomType
field in the return type.
Refer to Custom Types for further details on creating provider-defined types and values.
Documentation
Return documentation is expected in the top-level function documentation. Refer to function documentation for information about the Summary
, Description
, and MarkdownDescription
fields available.
Setting Return Data
The function implementation documentation covers the general methods for setting function return data in function logic.
When setting the value for this return:
- If
CustomType
is set, use its associated value type. - Otherwise, use the Go built-in
float64
type, Go built-in*float64
type, or framework float64 type.
In this example, a function defines a float64 return and sets its value: