inspect

Documentation

Index

• func CheckReference(sa flows.SessionAssets, ref assets.Reference) bool
• func Dependencies(s any, localization flows.Localization, ...)
• func ExtractFromTemplate(template string) ([]assets.Reference, []string)
• func LocalizableText(s any, include func(uuids.UUID, string, []string, func([]string)))
• func NewDependencies(refs []flows.ExtractedReference, sa flows.SessionAssets) []flows.Dependency
• func Results(s any, include func(*flows.ResultInfo))
• func TemplatePaths(t reflect.Type) []string
• func Templates(s any, localization flows.Localization, include func(i18n.Language, string))
• func Translations(localization flows.Localization, itemUUID uuids.UUID, property string, ...)
• type Dependency
  • func (d Dependency) MarshalJSON() ([]byte, error)
  • func (d *Dependency) Missing() bool
  • func (d *Dependency) Reference() assets.Reference
  • func (d *Dependency) Type() string
• type DependencyContainer
• type EngineField
• type ResultContainer

Functions

func CheckReference

func CheckReference(sa flows.SessionAssets, ref assets.Reference) bool

CheckReference determines whether this reference is accessible

func Dependencies

func Dependencies(s any, localization flows.Localization, include func(i18n.Language, assets.Reference))

Dependencies extracts dependencies

func ExtractFromTemplate

func ExtractFromTemplate(template string) ([]assets.Reference, []string)

ExtractFromTemplate extracts asset references and parent result references from the given template. Note that duplicates are not removed.

func LocalizableText

func LocalizableText(s any, include func(uuids.UUID, string, []string, func([]string)))

LocalizableText extracts localizable text by reading engine tags on a struct

func NewDependencies

func NewDependencies(refs []flows.ExtractedReference, sa flows.SessionAssets) []flows.Dependency

NewDependencies inspects a list of references. If a session assets is provided, each dependency is checked to see if it is available or missing.

func Results

func Results(s any, include func(*flows.ResultInfo))

Results extracts result infos

func TemplatePaths

func TemplatePaths(t reflect.Type) []string

func Templates

func Templates(s any, localization flows.Localization, include func(i18n.Language, string))

Templates extracts template values by reading engine tags on a struct

func Translations

func Translations(localization flows.Localization, itemUUID uuids.UUID, property string, include func(i18n.Language, string))

Types

type Dependency

type Dependency struct {
	Reference_ assets.Reference `json:"-"`
	Type_      string           `json:"type"`
	Missing_   bool             `json:"missing,omitempty"`
}

func (Dependency) MarshalJSON

func (d Dependency) MarshalJSON() ([]byte, error)

func (*Dependency) Missing

func (d *Dependency) Missing() bool

func (*Dependency) Reference

func (d *Dependency) Reference() assets.Reference

func (*Dependency) Type

func (d *Dependency) Type() string

type DependencyContainer

type DependencyContainer interface {
	Dependencies(flows.Localization, func(i18n.Language, assets.Reference))
}

DependencyContainer allows flow objects to declare other dependencies

type EngineField

type EngineField struct {
	Type      reflect.Type
	JSONName  string
	Localized bool
	Evaluated bool
	Getter    func(reflect.Value) reflect.Value
}

EngineField is a struct field which is part of the flow spec (i.e. included in JSON) and optionally has a engine tag

type ResultContainer

type ResultContainer interface {
	Results(func(*flows.ResultInfo))
}

ResultContainer allows flow objects to declare that they can generate a result