Documentation
¶
Index ¶
Constants ¶
const (
// ModuleName is the prefix given to all the functions in this module.
ModuleName = "os"
)
Variables ¶
This section is empty.
Functions ¶
func IsArchLinux ¶
IsArchLinux detects if the os family is archlinux. TODO: Detect OS changes.
Types ¶
type ReadFileFunc ¶
type ReadFileFunc struct {
// contains filtered or unexported fields
}
ReadFileFunc is a function that reads the full contents from a local file. If the file contents change or the file path changes, a new string will be sent. Please note that this is different from the readfile function in the deploy package.
func (*ReadFileFunc) ArgGen ¶
func (obj *ReadFileFunc) ArgGen(index int) (string, error)
ArgGen returns the Nth arg name for this function.
func (*ReadFileFunc) Close ¶
func (obj *ReadFileFunc) Close() error
Close runs some shutdown code for this function and turns off the stream.
func (*ReadFileFunc) Info ¶
func (obj *ReadFileFunc) Info() *interfaces.Info
Info returns some static info about itself.
func (*ReadFileFunc) Init ¶
func (obj *ReadFileFunc) Init(init *interfaces.Init) error
Init runs some startup code for this function.
func (*ReadFileFunc) Stream ¶
func (obj *ReadFileFunc) Stream() error
Stream returns the changing values that this func has over time.
func (*ReadFileFunc) Validate ¶
func (obj *ReadFileFunc) Validate() error
Validate makes sure we've built our struct properly. It is usually unused for normal functions that users can use directly.