flow

package
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2021 License: Apache-2.0 Imports: 19 Imported by: 1

Documentation

Index

Constants

View Source
const MODE_FILE_ACCESS = 1 // support file system access
View Source
const MODE_OS_ACCESS = 2 // support os commands like pipe and exec

Variables

This section is empty.

Functions

func Apply added in v1.2.0

func Apply(outer dynaml.Binding, template yaml.Node, prepared []yaml.Node, opts Options) (yaml.Node, error)

func Cascade

func Cascade(outer dynaml.Binding, template yaml.Node, opts Options, stubs ...yaml.Node) (yaml.Node, error)

func Cleanup added in v1.2.0

func Cleanup(node yaml.Node, test CleanupFunction) yaml.Node

func CleanupEnvironment added in v1.3.0

func CleanupEnvironment(binding dynaml.Binding)

func DetermineState added in v1.6.0

func DetermineState(node yaml.Node) yaml.Node

func FindInScopes added in v1.6.0

func FindInScopes(nodescope *Scope, path []string) (yaml.Node, bool)

func Flow

func Flow(source yaml.Node, stubs ...yaml.Node) (yaml.Node, error)

func FlowString added in v1.5.0

func FlowString(root yaml.Node, env dynaml.Binding) (yaml.Node, error)

func NestedFlow added in v1.3.0

func NestedFlow(outer dynaml.Binding, source yaml.Node, stubs ...yaml.Node) (yaml.Node, error)

func NewEnvironment added in v1.2.0

func NewEnvironment(stubs []yaml.Node, source string, optstate ...*State) dynaml.Binding

func NewNestedEnvironment added in v1.3.0

func NewNestedEnvironment(stubs []yaml.Node, source string, outer dynaml.Binding) dynaml.Binding

func NewProcessLocalEnvironment added in v1.5.0

func NewProcessLocalEnvironment(stubs []yaml.Node, source string) dynaml.Binding

func PrepareStubs added in v1.2.0

func PrepareStubs(outer dynaml.Binding, partial bool, stubs ...yaml.Node) ([]yaml.Node, error)

func ProcessKeyTag added in v1.2.0

func ProcessKeyTag(val yaml.Node) (yaml.Node, string)

Types

type CleanupFunction added in v1.3.0

type CleanupFunction func(yaml.Node) (yaml.Node, CleanupFunction)

func DiscardNonState added in v1.4.0

func DiscardNonState(node yaml.Node) (yaml.Node, CleanupFunction)

type DefaultEnvironment added in v1.2.0

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

func (DefaultEnvironment) Active added in v1.3.0

func (e DefaultEnvironment) Active() bool

func (DefaultEnvironment) Cascade added in v1.2.0

func (e DefaultEnvironment) Cascade(outer dynaml.Binding, template yaml.Node, partial bool, templates ...yaml.Node) (yaml.Node, error)

func (DefaultEnvironment) CurrentSourceName added in v1.2.0

func (e DefaultEnvironment) CurrentSourceName() string

func (DefaultEnvironment) Deactivate added in v1.3.0

func (e DefaultEnvironment) Deactivate() dynaml.Binding

func (DefaultEnvironment) FindFromRoot added in v1.2.0

func (e DefaultEnvironment) FindFromRoot(path []string) (yaml.Node, bool)

func (DefaultEnvironment) FindInStubs added in v1.2.0

func (e DefaultEnvironment) FindInStubs(path []string) (yaml.Node, bool)

func (DefaultEnvironment) FindReference added in v1.2.0

func (e DefaultEnvironment) FindReference(path []string) (yaml.Node, bool)

func (DefaultEnvironment) Flow added in v1.2.0

func (e DefaultEnvironment) Flow(source yaml.Node, shouldOverride bool) (yaml.Node, dynaml.Status)

func (DefaultEnvironment) GetFileContent added in v1.3.0

func (e DefaultEnvironment) GetFileContent(file string, cached bool) ([]byte, error)

func (DefaultEnvironment) GetRootBinding added in v1.3.0

func (e DefaultEnvironment) GetRootBinding() map[string]yaml.Node

func (DefaultEnvironment) GetScope added in v1.3.0

func (e DefaultEnvironment) GetScope() *Scope

func (DefaultEnvironment) GetState added in v1.3.0

func (e DefaultEnvironment) GetState() dynaml.State

func (DefaultEnvironment) GetStaticBinding added in v1.3.0

func (e DefaultEnvironment) GetStaticBinding() map[string]yaml.Node

func (DefaultEnvironment) GetTempName added in v1.3.0

func (e DefaultEnvironment) GetTempName(data []byte) (string, error)

func (DefaultEnvironment) NoMerge added in v1.3.0

func (e DefaultEnvironment) NoMerge() bool

func (DefaultEnvironment) Outer added in v1.3.0

func (e DefaultEnvironment) Outer() dynaml.Binding

func (DefaultEnvironment) Path added in v1.2.0

func (e DefaultEnvironment) Path() []string

func (DefaultEnvironment) RedirectOverwrite added in v1.2.0

func (e DefaultEnvironment) RedirectOverwrite(path []string) dynaml.Binding

func (DefaultEnvironment) SourceName added in v1.2.0

func (e DefaultEnvironment) SourceName() string

func (DefaultEnvironment) String added in v1.3.0

func (e DefaultEnvironment) String() string

func (DefaultEnvironment) StubPath added in v1.2.0

func (e DefaultEnvironment) StubPath() []string

func (DefaultEnvironment) WithLocalScope added in v1.2.0

func (e DefaultEnvironment) WithLocalScope(step map[string]yaml.Node) dynaml.Binding

func (DefaultEnvironment) WithNewRoot added in v1.3.0

func (e DefaultEnvironment) WithNewRoot() dynaml.Binding

func (DefaultEnvironment) WithPath added in v1.2.0

func (e DefaultEnvironment) WithPath(step string) dynaml.Binding

func (DefaultEnvironment) WithScope added in v1.2.0

func (e DefaultEnvironment) WithScope(step map[string]yaml.Node) dynaml.Binding

func (DefaultEnvironment) WithSource added in v1.2.0

func (e DefaultEnvironment) WithSource(source string) dynaml.Binding

type Options added in v1.5.0

type Options struct {
	// PreserveEscapes prevents escaped dynaml expressions to be unescaped for the final output
	PreserveEscapes bool
	// PreserveTemporary will keep temporary elements in the final output
	PreserveTemporary bool
	// Partial will not treat unevaluated dynaml expressions as error, but keep it in the output.
	Partial bool
}

Options bundles the options for processing yaml templates

type Scope

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

type State added in v1.3.0

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

func NewState added in v1.3.0

func NewState(key string, mode int, optfs ...vfs.FileSystem) *State

func (*State) Cleanup added in v1.3.0

func (s *State) Cleanup()

func (*State) FileAccessAllowed added in v1.6.0

func (s *State) FileAccessAllowed() bool

func (*State) FileSystem added in v1.6.0

func (s *State) FileSystem() vfs.VFS

func (*State) GetEncryptionKey added in v1.3.0

func (s *State) GetEncryptionKey() string

func (*State) GetFileContent added in v1.3.0

func (s *State) GetFileContent(file string, cached bool) ([]byte, error)

func (*State) GetFunctions added in v1.6.0

func (s *State) GetFunctions() dynaml.Registry

func (*State) GetTempName added in v1.3.0

func (s *State) GetTempName(data []byte) (string, error)

func (*State) OSAccessAllowed added in v1.5.0

func (s *State) OSAccessAllowed() bool

func (*State) SetFunctions added in v1.6.0

func (s *State) SetFunctions(f dynaml.Registry) *State

type Updateable added in v1.3.0

type Updateable interface {
	Active() bool
	GetScope() *Scope
	Deactivate() dynaml.Binding
}

Jump to

Keyboard shortcuts

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