function

package

Go to main page

Versions in this module

v1

v1.16.0

Sep 17, 2025

v1.16.0-beta.1

Jul 31, 2025

v1.16.0-alpha.1

Jul 22, 2025

v1.15.1

Jul 31, 2025

v1.15.0

May 16, 2025

v1.15.0-beta.1

Apr 15, 2025

v1.15.0-alpha.1

Mar 18, 2025

v1.14.1

Feb 20, 2025

v1.14.0

Feb 19, 2025

v1.13.0

Oct 31, 2024

v1.12.0

Sep 18, 2024

v1.11.0

Aug 6, 2024

v1.10.0

Jul 9, 2024

Changes in this version

+ type Float32Parameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.Float32Typable

+ Description string

+ MarkdownDescription string

+ Name string

+ Validators []Float32ParameterValidator

+ func (p Float32Parameter) GetAllowNullValue() bool

+ func (p Float32Parameter) GetAllowUnknownValues() bool

+ func (p Float32Parameter) GetDescription() string

+ func (p Float32Parameter) GetMarkdownDescription() string

+ func (p Float32Parameter) GetName() string

+ func (p Float32Parameter) GetType() attr.Type

+ func (p Float32Parameter) GetValidators() []Float32ParameterValidator

+ func (p Float32Parameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

+ type Float32ParameterValidator interface

+ ValidateParameterFloat32 func(context.Context, Float32ParameterValidatorRequest, ...)

+ type Float32ParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Float32

+ type Float32ParameterValidatorResponse struct

+ Error *FuncError

+ type Float32Return struct

+ CustomType basetypes.Float32Typable

+ func (r Float32Return) GetType() attr.Type

+ func (r Float32Return) NewResultData(ctx context.Context) (ResultData, *FuncError)

+ type Int32Parameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.Int32Typable

+ Description string

+ MarkdownDescription string

+ Name string

+ Validators []Int32ParameterValidator

+ func (p Int32Parameter) GetAllowNullValue() bool

+ func (p Int32Parameter) GetAllowUnknownValues() bool

+ func (p Int32Parameter) GetDescription() string

+ func (p Int32Parameter) GetMarkdownDescription() string

+ func (p Int32Parameter) GetName() string

+ func (p Int32Parameter) GetType() attr.Type

+ func (p Int32Parameter) GetValidators() []Int32ParameterValidator

+ func (p Int32Parameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

+ type Int32ParameterValidator interface

+ ValidateParameterInt32 func(context.Context, Int32ParameterValidatorRequest, ...)

+ type Int32ParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Int32

+ type Int32ParameterValidatorResponse struct

+ Error *FuncError

+ type Int32Return struct

+ CustomType basetypes.Int32Typable

+ func (r Int32Return) GetType() attr.Type

+ func (r Int32Return) NewResultData(ctx context.Context) (ResultData, *FuncError)

+ type ParameterWithFloat32Validators interface

+ GetValidators func() []Float32ParameterValidator

+ type ParameterWithInt32Validators interface

+ GetValidators func() []Int32ParameterValidator

v1.9.0

Jun 4, 2024

Changes in this version

type BoolParameter

+ func (p BoolParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type DynamicParameter

+ func (p DynamicParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type Float64Parameter

+ func (p Float64Parameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type Int64Parameter

+ func (p Int64Parameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type NumberParameter

+ func (p NumberParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type StringParameter

+ func (p StringParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

v1.8.0

Apr 18, 2024

Changes in this version

type BoolParameter

+ Validators []BoolParameterValidator

+ func (p BoolParameter) GetValidators() []BoolParameterValidator

+ type BoolParameterValidator interface

+ ValidateParameterBool func(context.Context, BoolParameterValidatorRequest, ...)

+ type BoolParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Bool

+ type BoolParameterValidatorResponse struct

+ Error *FuncError

type DynamicParameter

+ Validators []DynamicParameterValidator

+ func (p DynamicParameter) GetValidators() []DynamicParameterValidator

+ type DynamicParameterValidator interface

+ ValidateParameterDynamic func(context.Context, DynamicParameterValidatorRequest, ...)

+ type DynamicParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Dynamic

+ type DynamicParameterValidatorResponse struct

+ Error *FuncError

type Float64Parameter

+ Validators []Float64ParameterValidator

+ func (p Float64Parameter) GetValidators() []Float64ParameterValidator

+ type Float64ParameterValidator interface

+ ValidateParameterFloat64 func(context.Context, Float64ParameterValidatorRequest, ...)

+ type Float64ParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Float64

+ type Float64ParameterValidatorResponse struct

+ Error *FuncError

type Int64Parameter

+ Validators []Int64ParameterValidator

+ func (p Int64Parameter) GetValidators() []Int64ParameterValidator

+ type Int64ParameterValidator interface

+ ValidateParameterInt64 func(context.Context, Int64ParameterValidatorRequest, ...)

+ type Int64ParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Int64

+ type Int64ParameterValidatorResponse struct

+ Error *FuncError

type ListParameter

+ Validators []ListParameterValidator

+ func (p ListParameter) GetValidators() []ListParameterValidator

+ type ListParameterValidator interface

+ ValidateParameterList func(context.Context, ListParameterValidatorRequest, ...)

+ type ListParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.List

+ type ListParameterValidatorResponse struct

+ Error *FuncError

type MapParameter

+ Validators []MapParameterValidator

+ func (p MapParameter) GetValidators() []MapParameterValidator

+ type MapParameterValidator interface

+ ValidateParameterMap func(context.Context, MapParameterValidatorRequest, *MapParameterValidatorResponse)

+ type MapParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Map

+ type MapParameterValidatorResponse struct

+ Error *FuncError

type NumberParameter

+ Validators []NumberParameterValidator

+ func (p NumberParameter) GetValidators() []NumberParameterValidator

+ type NumberParameterValidator interface

+ ValidateParameterNumber func(context.Context, NumberParameterValidatorRequest, ...)

+ type NumberParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Number

+ type NumberParameterValidatorResponse struct

+ Error *FuncError

type ObjectParameter

+ Validators []ObjectParameterValidator

+ func (p ObjectParameter) GetValidators() []ObjectParameterValidator

+ type ObjectParameterValidator interface

+ ValidateParameterObject func(context.Context, ObjectParameterValidatorRequest, ...)

+ type ObjectParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Object

+ type ObjectParameterValidatorResponse struct

+ Error *FuncError

+ type ParameterWithBoolValidators interface

+ GetValidators func() []BoolParameterValidator

+ type ParameterWithDynamicValidators interface

+ GetValidators func() []DynamicParameterValidator

+ type ParameterWithFloat64Validators interface

+ GetValidators func() []Float64ParameterValidator

+ type ParameterWithInt64Validators interface

+ GetValidators func() []Int64ParameterValidator

+ type ParameterWithListValidators interface

+ GetValidators func() []ListParameterValidator

+ type ParameterWithMapValidators interface

+ GetValidators func() []MapParameterValidator

+ type ParameterWithNumberValidators interface

+ GetValidators func() []NumberParameterValidator

+ type ParameterWithObjectValidators interface

+ GetValidators func() []ObjectParameterValidator

+ type ParameterWithSetValidators interface

+ GetValidators func() []SetParameterValidator

+ type ParameterWithStringValidators interface

+ GetValidators func() []StringParameterValidator

type SetParameter

+ Validators []SetParameterValidator

+ func (p SetParameter) GetValidators() []SetParameterValidator

+ type SetParameterValidator interface

+ ValidateParameterSet func(context.Context, SetParameterValidatorRequest, *SetParameterValidatorResponse)

+ type SetParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.Set

+ type SetParameterValidatorResponse struct

+ Error *FuncError

type StringParameter

+ Validators []StringParameterValidator

+ func (p StringParameter) GetValidators() []StringParameterValidator

+ type StringParameterValidator interface

+ ValidateParameterString func(context.Context, StringParameterValidatorRequest, ...)

+ type StringParameterValidatorRequest struct

+ ArgumentPosition int64

+ Value types.String

+ type StringParameterValidatorResponse struct

+ Error *FuncError

+ type ValidateParameterRequest struct

+ Position int64

+ type ValidateParameterResponse struct

+ Error *FuncError

+ type ValidateableParameter interface

+ ValidateParameter func(context.Context, ValidateParameterRequest, *ValidateParameterResponse)

v1.7.0

Mar 21, 2024

Changes in this version

+ type DefinitionValidateRequest struct

+ FuncName string

+ type DefinitionValidateResponse struct

+ Diagnostics diag.Diagnostics

+ type DynamicParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.DynamicTypable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p DynamicParameter) GetAllowNullValue() bool

+ func (p DynamicParameter) GetAllowUnknownValues() bool

+ func (p DynamicParameter) GetDescription() string

+ func (p DynamicParameter) GetMarkdownDescription() string

+ func (p DynamicParameter) GetName() string

+ func (p DynamicParameter) GetType() attr.Type

+ type DynamicReturn struct

+ CustomType basetypes.DynamicTypable

+ func (r DynamicReturn) GetType() attr.Type

+ func (r DynamicReturn) NewResultData(ctx context.Context) (ResultData, *FuncError)

type ListParameter

+ func (p ListParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type ListReturn

+ func (p ListReturn) ValidateImplementation(ctx context.Context, req fwfunction.ValidateReturnImplementationRequest, ...)

type MapParameter

+ func (p MapParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type MapReturn

+ func (p MapReturn) ValidateImplementation(ctx context.Context, req fwfunction.ValidateReturnImplementationRequest, ...)

type ObjectParameter

+ func (p ObjectParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type ObjectReturn

+ func (p ObjectReturn) ValidateImplementation(ctx context.Context, req fwfunction.ValidateReturnImplementationRequest, ...)

type SetParameter

+ func (p SetParameter) ValidateImplementation(ctx context.Context, req fwfunction.ValidateParameterImplementationRequest, ...)

type SetReturn

+ func (p SetReturn) ValidateImplementation(ctx context.Context, req fwfunction.ValidateReturnImplementationRequest, ...)

v1.6.1

Mar 5, 2024

Changes in this version

+ const DefaultParameterNamePrefix

+ const DefaultVariadicParameterName

v1.6.0

Feb 28, 2024

Changes in this version

+ type FuncError struct

+ FunctionArgument *int64

+ Text string

+ func ConcatFuncErrors(funcErrs ...*FuncError) *FuncError

+ func FuncErrorFromDiags(ctx context.Context, diags diag.Diagnostics) *FuncError

+ func NewArgumentFuncError(functionArgument int64, text string) *FuncError

+ func NewFuncError(text string) *FuncError

+ func (fe *FuncError) Equal(other *FuncError) bool

+ func (fe *FuncError) Error() string

type RunResponse

+ Error *FuncError

v1.5.0

Jan 11, 2024

Changes in this version

+ const DefaultParameterName

+ type ArgumentsData struct

+ func NewArgumentsData(values []attr.Value) ArgumentsData

+ func (d ArgumentsData) Equal(o ArgumentsData) bool

+ func (d ArgumentsData) Get(ctx context.Context, targets ...any) diag.Diagnostics

+ func (d ArgumentsData) GetArgument(ctx context.Context, position int, target any) diag.Diagnostics

+ type BoolParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.BoolTypable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p BoolParameter) GetAllowNullValue() bool

+ func (p BoolParameter) GetAllowUnknownValues() bool

+ func (p BoolParameter) GetDescription() string

+ func (p BoolParameter) GetMarkdownDescription() string

+ func (p BoolParameter) GetName() string

+ func (p BoolParameter) GetType() attr.Type

+ type BoolReturn struct

+ CustomType basetypes.BoolTypable

+ func (r BoolReturn) GetType() attr.Type

+ func (r BoolReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type Definition struct

+ DeprecationMessage string

+ Description string

+ MarkdownDescription string

+ Parameters []Parameter

+ Return Return

+ Summary string

+ VariadicParameter Parameter

+ func (d Definition) Parameter(ctx context.Context, position int) (Parameter, diag.Diagnostics)

+ func (d Definition) ValidateImplementation(ctx context.Context) diag.Diagnostics

+ type DefinitionRequest struct

+ type DefinitionResponse struct

+ Definition Definition

+ Diagnostics diag.Diagnostics

+ type Float64Parameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.Float64Typable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p Float64Parameter) GetAllowNullValue() bool

+ func (p Float64Parameter) GetAllowUnknownValues() bool

+ func (p Float64Parameter) GetDescription() string

+ func (p Float64Parameter) GetMarkdownDescription() string

+ func (p Float64Parameter) GetName() string

+ func (p Float64Parameter) GetType() attr.Type

+ type Float64Return struct

+ CustomType basetypes.Float64Typable

+ func (r Float64Return) GetType() attr.Type

+ func (r Float64Return) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type Function interface

+ Definition func(context.Context, DefinitionRequest, *DefinitionResponse)

+ Metadata func(context.Context, MetadataRequest, *MetadataResponse)

+ Run func(context.Context, RunRequest, *RunResponse)

+ type Int64Parameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.Int64Typable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p Int64Parameter) GetAllowNullValue() bool

+ func (p Int64Parameter) GetAllowUnknownValues() bool

+ func (p Int64Parameter) GetDescription() string

+ func (p Int64Parameter) GetMarkdownDescription() string

+ func (p Int64Parameter) GetName() string

+ func (p Int64Parameter) GetType() attr.Type

+ type Int64Return struct

+ CustomType basetypes.Int64Typable

+ func (r Int64Return) GetType() attr.Type

+ func (r Int64Return) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type ListParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.ListTypable

+ Description string

+ ElementType attr.Type

+ MarkdownDescription string

+ Name string

+ func (p ListParameter) GetAllowNullValue() bool

+ func (p ListParameter) GetAllowUnknownValues() bool

+ func (p ListParameter) GetDescription() string

+ func (p ListParameter) GetMarkdownDescription() string

+ func (p ListParameter) GetName() string

+ func (p ListParameter) GetType() attr.Type

+ type ListReturn struct

+ CustomType basetypes.ListTypable

+ ElementType attr.Type

+ func (r ListReturn) GetType() attr.Type

+ func (r ListReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type MapParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.MapTypable

+ Description string

+ ElementType attr.Type

+ MarkdownDescription string

+ Name string

+ func (p MapParameter) GetAllowNullValue() bool

+ func (p MapParameter) GetAllowUnknownValues() bool

+ func (p MapParameter) GetDescription() string

+ func (p MapParameter) GetMarkdownDescription() string

+ func (p MapParameter) GetName() string

+ func (p MapParameter) GetType() attr.Type

+ type MapReturn struct

+ CustomType basetypes.MapTypable

+ ElementType attr.Type

+ func (r MapReturn) GetType() attr.Type

+ func (r MapReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type MetadataRequest struct

+ type MetadataResponse struct

+ Name string

+ type NumberParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.NumberTypable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p NumberParameter) GetAllowNullValue() bool

+ func (p NumberParameter) GetAllowUnknownValues() bool

+ func (p NumberParameter) GetDescription() string

+ func (p NumberParameter) GetMarkdownDescription() string

+ func (p NumberParameter) GetName() string

+ func (p NumberParameter) GetType() attr.Type

+ type NumberReturn struct

+ CustomType basetypes.NumberTypable

+ func (r NumberReturn) GetType() attr.Type

+ func (r NumberReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type ObjectParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ AttributeTypes map[string]attr.Type

+ CustomType basetypes.ObjectTypable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p ObjectParameter) GetAllowNullValue() bool

+ func (p ObjectParameter) GetAllowUnknownValues() bool

+ func (p ObjectParameter) GetDescription() string

+ func (p ObjectParameter) GetMarkdownDescription() string

+ func (p ObjectParameter) GetName() string

+ func (p ObjectParameter) GetType() attr.Type

+ type ObjectReturn struct

+ AttributeTypes map[string]attr.Type

+ CustomType basetypes.ObjectTypable

+ func (r ObjectReturn) GetType() attr.Type

+ func (r ObjectReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type Parameter interface

+ GetAllowNullValue func() bool

+ GetAllowUnknownValues func() bool

+ GetDescription func() string

+ GetMarkdownDescription func() string

+ GetName func() string

+ GetType func() attr.Type

+ type ResultData struct

+ func NewResultData(value attr.Value) ResultData

+ func (d *ResultData) Set(ctx context.Context, value any) diag.Diagnostics

+ func (d ResultData) Equal(o ResultData) bool

+ func (d ResultData) Value() attr.Value

+ type Return interface

+ GetType func() attr.Type

+ NewResultData func(context.Context) (ResultData, diag.Diagnostics)

+ type RunRequest struct

+ Arguments ArgumentsData

+ type RunResponse struct

+ Diagnostics diag.Diagnostics

+ Result ResultData

+ type SetParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.SetTypable

+ Description string

+ ElementType attr.Type

+ MarkdownDescription string

+ Name string

+ func (p SetParameter) GetAllowNullValue() bool

+ func (p SetParameter) GetAllowUnknownValues() bool

+ func (p SetParameter) GetDescription() string

+ func (p SetParameter) GetMarkdownDescription() string

+ func (p SetParameter) GetName() string

+ func (p SetParameter) GetType() attr.Type

+ type SetReturn struct

+ CustomType basetypes.SetTypable

+ ElementType attr.Type

+ func (r SetReturn) GetType() attr.Type

+ func (r SetReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

+ type StringParameter struct

+ AllowNullValue bool

+ AllowUnknownValues bool

+ CustomType basetypes.StringTypable

+ Description string

+ MarkdownDescription string

+ Name string

+ func (p StringParameter) GetAllowNullValue() bool

+ func (p StringParameter) GetAllowUnknownValues() bool

+ func (p StringParameter) GetDescription() string

+ func (p StringParameter) GetMarkdownDescription() string

+ func (p StringParameter) GetName() string

+ func (p StringParameter) GetType() attr.Type

+ type StringReturn struct

+ CustomType basetypes.StringTypable

+ func (r StringReturn) GetType() attr.Type

+ func (r StringReturn) NewResultData(ctx context.Context) (ResultData, diag.Diagnostics)

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