reflection

Documentation

Index

• Variables
• func CallingVerb() schema.RefKey
• func GetDiscriminatorByVariant(variant reflect.Type) optional.Option[reflect.Type]
• func GetVariantByName(discriminator reflect.Type, name string) optional.Option[reflect.Type]
• func GetVariantByType(discriminator reflect.Type, variantType reflect.Type) optional.Option[string]
• func IsKnownExternalType(t reflect.Type) bool
• func IsSumTypeDiscriminator(discriminator reflect.Type) bool
• func Module() string
• func ReflectTypeToSchemaType(t reflect.Type) schema.Type
• func Register(options ...Registree)
• func ResetTypeRegistry()
• func TypeFromValue[T any, TP interface{ ... }](v TP) schema.Type
• type Ref
  • func ClientRef[T any]() Ref
  • func FuncRef(call any) Ref
  • func ParseRef(ref string) (Ref, error)
  • func RefFromProto(p *schemapb.Ref) Ref
  • func TypeRef[T any]() Ref
  • func TypeRefFromValue(v any) Ref
  • func (v Ref) String() string
  • func (v Ref) ToProto() *schemapb.Ref
  • func (v Ref) ToSchema() *schema.Ref
  • func (v *Ref) UnmarshalText(text []byte) error
• type Registree
  • func ExternalType(goType any) Registree
  • func ProvideResourcesForVerb(verb any, rs ...VerbResource) Registree
  • func SumType[Discriminator any](variants ...Discriminator) Registree
• type TypeRegistry
• type VerbExec
  • func CallVerb(ref Ref) VerbExec
• type VerbResource

Variables

var AllowAnyPackageForTesting = false

Functions

func CallingVerb

func CallingVerb() schema.RefKey

func GetDiscriminatorByVariant

func GetDiscriminatorByVariant(variant reflect.Type) optional.Option[reflect.Type]

GetDiscriminatorByVariant returns the discriminator type for the given variant type.

func GetVariantByName

func GetVariantByName(discriminator reflect.Type, name string) optional.Option[reflect.Type]

GetVariantByName returns the variant type for the given discriminator and variant name.

func GetVariantByType

func GetVariantByType(discriminator reflect.Type, variantType reflect.Type) optional.Option[string]

GetVariantByType returns the variant name for the given discriminator and variant type.

func IsKnownExternalType

func IsKnownExternalType(t reflect.Type) bool

func IsSumTypeDiscriminator

func IsSumTypeDiscriminator(discriminator reflect.Type) bool

IsSumTypeDiscriminator returns true if the given type is a sum type discriminator.

func Module

func Module() string

Module returns the FTL module currently being executed.

func ReflectTypeToSchemaType

func ReflectTypeToSchemaType(t reflect.Type) schema.Type

ReflectTypeToSchemaType returns the FTL schema for a Go reflect.Type.

func Register

func Register(options ...Registree)

Register applies all the provided options to the singleton TypeRegistry

func ResetTypeRegistry

func ResetTypeRegistry()

ResetTypeRegistry clears the contents of the singleton type registry for tests to guarantee determinism.

func TypeFromValue

func TypeFromValue[T any, TP interface{ *T }](v TP) schema.Type

TypeFromValue reflects a schema.Type from a Go value.

The passed value must be a pointer to a value of the desired type. This is to ensure that interface values aren't dereferenced automatically by the Go compiler.

Types

type Ref

type Ref struct {
	Module string `json:"module"`
	Name   string `json:"name"`
}

Ref is an untyped reference to a symbol.

func ClientRef

func ClientRef[T any]() Ref

func FuncRef

func FuncRef(call any) Ref

FuncRef returns the Ref for a Go function.

Panics if called with a function outside FTL.

func ParseRef

func ParseRef(ref string) (Ref, error)

func RefFromProto

func RefFromProto(p *schemapb.Ref) Ref

func TypeRef

func TypeRef[T any]() Ref

TypeRef returns the Ref for a Go type.

Panics if called with a type outside of FTL.

func TypeRefFromValue

func TypeRefFromValue(v any) Ref

TypeRefFromValue returns the Ref for a Go value.

The value must be a named type such as a struct, enum, or sum type.

func (Ref) String

func (v Ref) String() string

func (Ref) ToProto

func (v Ref) ToProto() *schemapb.Ref

func (Ref) ToSchema

func (v Ref) ToSchema() *schema.Ref

func (*Ref) UnmarshalText

func (v *Ref) UnmarshalText(text []byte) error

type Registree

type Registree func(t *TypeRegistry)

Registree is a function that registers types with a TypeRegistry.

func ExternalType

func ExternalType(goType any) Registree

ExternalType adds a non-FTL type to the type registry.

func ProvideResourcesForVerb

func ProvideResourcesForVerb(verb any, rs ...VerbResource) Registree

ProvideResourcesForVerb registers any resources that must be provided when calling the given verb.

func SumType

func SumType[Discriminator any](variants ...Discriminator) Registree

SumType adds a sum type and its variants to the type registry.

type TypeRegistry

type TypeRegistry struct {
	// contains filtered or unexported fields
}

TypeRegistry is used for dynamic type resolution at runtime. It stores associations between sum type discriminators and their variants, for use in encoding and decoding.

FTL manages the type registry for you, so you don't need to create one yourself.

type VerbExec

type VerbExec func(ctx context.Context, req optional.Option[any]) (optional.Option[any], error)

VerbExec is a function for executing a verb.

func CallVerb

func CallVerb(ref Ref) VerbExec

type VerbResource

type VerbResource func() reflect.Value

VerbResource is a function that registers a resource for a Verb.