Documentation
¶
Index ¶
Constants ¶
const Answer = 42
Answer is the Answer to Life, the Universe and Everything.
const (
// ModuleName is the prefix given to all the functions in this module.
ModuleName = "example"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type FlipFlopFact ¶
type FlipFlopFact struct {
// contains filtered or unexported fields
}
FlipFlopFact is a fact which flips a bool repeatedly. This is an example fact and is not meant for serious computing. This would be better served by a flip function which you could specify an interval for.
func (*FlipFlopFact) Close ¶
func (obj *FlipFlopFact) Close() error
Close runs some shutdown code for this fact and turns off the stream.
func (*FlipFlopFact) Info ¶
func (obj *FlipFlopFact) Info() *facts.Info
Info returns some static info about itself.
func (*FlipFlopFact) Init ¶
func (obj *FlipFlopFact) Init(init *facts.Init) error
Init runs some startup code for this fact.
func (*FlipFlopFact) Stream ¶
func (obj *FlipFlopFact) Stream() error
Stream returns the changing values that this fact has over time.
type VUMeterFunc ¶
type VUMeterFunc struct {
// contains filtered or unexported fields
}
VUMeterFunc is a gimmic function to display a vu meter from the microphone.
func (*VUMeterFunc) ArgGen ¶
func (obj *VUMeterFunc) ArgGen(index int) (string, error)
ArgGen returns the Nth arg name for this function.
func (*VUMeterFunc) Close ¶
func (obj *VUMeterFunc) Close() error
Close runs some shutdown code for this function and turns off the stream.
func (*VUMeterFunc) Info ¶
func (obj *VUMeterFunc) Info() *interfaces.Info
Info returns some static info about itself.
func (*VUMeterFunc) Init ¶
func (obj *VUMeterFunc) Init(init *interfaces.Init) error
Init runs some startup code for this function.
func (*VUMeterFunc) Stream ¶
func (obj *VUMeterFunc) Stream() error
Stream returns the changing values that this func has over time.
func (*VUMeterFunc) Validate ¶
func (obj *VUMeterFunc) Validate() error
Validate makes sure we've built our struct properly. It is usually unused for normal functions that users can use directly.
Source Files
Directories