stage

Documentation

Index

• type Enabler
• type Instance
  • func (f Instance) ID() string
• type Instancer
• type MiddleDemuxProvider
• type MiddleProvider
• type StartDemuxProvider
• type StartMultiProvider
• type StartProvider
• type TerminalProvider

Types

type Enabler

type Enabler interface {
	Enabled() bool
}

Enabler is an optional interface that tells whether a node is enabled. If the node config implements it and Enabled() is false, the node won't be added to the graph. This is useful for non-nillable configurations that need to be disabled if e.g. a property is missing. IMPORTANT: The method needs to be implemented by using a value as receiver. Deprecated package. Use github.com/mariomac/pipes/pipe package

type Instance

type Instance string

Instance can be embedded into any stage configuration to be instantiable (convenience implementation for the required Instancer interface) Deprecated package. Use github.com/mariomac/pipes/pipe package

func (Instance) ID

func (f Instance) ID() string

type Instancer

type Instancer interface {
	ID() string
}

Instancer is the interface required by any stage configuration type that is instantiated from the builder.ApplyConfig method. Deprecated package. Use github.com/mariomac/pipes/pipe package

type MiddleDemuxProvider

type MiddleDemuxProvider[CFG, I any] func(CFG) (node.MiddleDemuxFunc[I], error)

MiddleDemuxProvider is a function that, given a configuration argument of a unique type, returns a function fulfilling the node.MiddleDemuxFunc type signature. Returned functions will run inside a Graph Middle Node. If it returns an error, the graph building process will be interrupted. The configuration type must either implement the stage.Instancer interface or the configuration struct containing it must define a `nodeId` tag with an identifier for that stage. Deprecated package. Use github.com/mariomac/pipes/pipe package

type MiddleProvider

type MiddleProvider[CFG, I, O any] func(CFG) (node.MiddleFunc[I, O], error)

MiddleProvider is a function that, given a configuration argument of a unique type, returns a function fulfilling the node.MiddleFunc type signature. Returned functions will run inside a Graph Middle Node. If it returns an error, the graph building process will be interrupted. The configuration type must either implement the stage.Instancer interface or the configuration struct containing it must define a `nodeId` tag with an identifier for that stage. Deprecated package. Use github.com/mariomac/pipes/pipe package

type StartDemuxProvider

type StartDemuxProvider[CFG any] func(CFG) (node.StartDemuxFunc, error)

StartDemuxProvider is a function that, given a configuration argument of a unique type, returns a function fulfilling the node.StartFuncDemux type signature. Returned function will run inside a Graph Start Node If it returns an error, the graph building process will be interrupted. The configuration type must either implement the stage.Instancer interface or the configuration struct containing it must define a `nodeId` tag with an identifier for that stage. Deprecated package. Use github.com/mariomac/pipes/pipe package

type StartMultiProvider

type StartMultiProvider[CFG, O any] func(CFG) ([]node.StartFunc[O], error)

StartMultiProvider is similar to StarProvider, but it is able to associate a variadic number of functions that will behave as a single node. Deprecated package. Use github.com/mariomac/pipes/pipe package

type StartProvider

type StartProvider[CFG, O any] func(CFG) (node.StartFunc[O], error)

StartProvider is a function that, given a configuration argument of a unique type, returns a function fulfilling the node.StartFunc type signature. Returned function will run inside a Graph Start Node If it returns an error, the graph building process will be interrupted. The configuration type must either implement the stage.Instancer interface or the configuration struct containing it must define a `nodeId` tag with an identifier for that stage. Deprecated package. Use github.com/mariomac/pipes/pipe package

type TerminalProvider

type TerminalProvider[CFG, I any] func(CFG) (node.TerminalFunc[I], error)

TerminalProvider is a function that, given a configuration argument of a unique type, returns a function fulfilling the node.TerminalFunc type signature. Returned functions will run inside a Graph Terminal Node. If it returns an error, the graph building process will be interrupted. The configuration type must either implement the stage.Instancer interface or the configuration struct containing it must define a `nodeId` tag with an identifier for that stage. Deprecated package. Use github.com/mariomac/pipes/pipe package