Documentation
¶
Index ¶
- Constants
- type AbsPathFunc
- func (obj *AbsPathFunc) ArgGen(index int) (string, error)
- func (obj *AbsPathFunc) Close() error
- func (obj *AbsPathFunc) Info() *interfaces.Info
- func (obj *AbsPathFunc) Init(init *interfaces.Init) error
- func (obj *AbsPathFunc) SetData(data *interfaces.FuncData)
- func (obj *AbsPathFunc) Stream() error
- func (obj *AbsPathFunc) Validate() error
- type ReadFileAbsFunc
- func (obj *ReadFileAbsFunc) ArgGen(index int) (string, error)
- func (obj *ReadFileAbsFunc) Close() error
- func (obj *ReadFileAbsFunc) Info() *interfaces.Info
- func (obj *ReadFileAbsFunc) Init(init *interfaces.Init) error
- func (obj *ReadFileAbsFunc) SetData(data *interfaces.FuncData)
- func (obj *ReadFileAbsFunc) Stream() error
- func (obj *ReadFileAbsFunc) Validate() error
- type ReadFileFunc
- func (obj *ReadFileFunc) ArgGen(index int) (string, error)
- func (obj *ReadFileFunc) Close() error
- func (obj *ReadFileFunc) Info() *interfaces.Info
- func (obj *ReadFileFunc) Init(init *interfaces.Init) error
- func (obj *ReadFileFunc) SetData(data *interfaces.FuncData)
- func (obj *ReadFileFunc) Stream() error
- func (obj *ReadFileFunc) Validate() error
Constants ¶
const (
// ModuleName is the prefix given to all the functions in this module.
ModuleName = "deploy"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AbsPathFunc ¶
type AbsPathFunc struct {
// contains filtered or unexported fields
}
AbsPathFunc is a function that returns the absolute, full path in the deploy from an input path that is relative to the calling file. If you pass it an empty string, you'll just get the absolute deploy directory path that you're in.
func (*AbsPathFunc) ArgGen ¶
func (obj *AbsPathFunc) ArgGen(index int) (string, error)
ArgGen returns the Nth arg name for this function.
func (*AbsPathFunc) Close ¶
func (obj *AbsPathFunc) Close() error
Close runs some shutdown code for this function and turns off the stream.
func (*AbsPathFunc) Info ¶
func (obj *AbsPathFunc) Info() *interfaces.Info
Info returns some static info about itself.
func (*AbsPathFunc) Init ¶
func (obj *AbsPathFunc) Init(init *interfaces.Init) error
Init runs some startup code for this function.
func (*AbsPathFunc) SetData ¶
func (obj *AbsPathFunc) SetData(data *interfaces.FuncData)
SetData is used by the language to pass our function some code-level context.
func (*AbsPathFunc) Stream ¶
func (obj *AbsPathFunc) Stream() error
Stream returns the changing values that this func has over time.
func (*AbsPathFunc) Validate ¶
func (obj *AbsPathFunc) Validate() error
Validate makes sure we've built our struct properly. It is usually unused for normal functions that users can use directly.
type ReadFileAbsFunc ¶
type ReadFileAbsFunc struct {
// contains filtered or unexported fields
}
ReadFileAbsFunc is a function that reads the full contents from a file in our deploy. The file contents can only change with a new deploy, so this is static. In particular, this takes an absolute path relative to the root deploy. In general, you should use `deploy.readfile` instead. Please note that this is different from the readfile function in the os package.
func (*ReadFileAbsFunc) ArgGen ¶
func (obj *ReadFileAbsFunc) ArgGen(index int) (string, error)
ArgGen returns the Nth arg name for this function.
func (*ReadFileAbsFunc) Close ¶
func (obj *ReadFileAbsFunc) Close() error
Close runs some shutdown code for this function and turns off the stream.
func (*ReadFileAbsFunc) Info ¶
func (obj *ReadFileAbsFunc) Info() *interfaces.Info
Info returns some static info about itself.
func (*ReadFileAbsFunc) Init ¶
func (obj *ReadFileAbsFunc) Init(init *interfaces.Init) error
Init runs some startup code for this function.
func (*ReadFileAbsFunc) SetData ¶
func (obj *ReadFileAbsFunc) SetData(data *interfaces.FuncData)
SetData is used by the language to pass our function some code-level context.
func (*ReadFileAbsFunc) Stream ¶
func (obj *ReadFileAbsFunc) Stream() error
Stream returns the changing values that this func has over time.
func (*ReadFileAbsFunc) Validate ¶
func (obj *ReadFileAbsFunc) Validate() error
Validate makes sure we've built our struct properly. It is usually unused for normal functions that users can use directly.
type ReadFileFunc ¶
type ReadFileFunc struct {
// contains filtered or unexported fields
}
ReadFileFunc is a function that reads the full contents from a file in our deploy. The file contents can only change with a new deploy, so this is static. Please note that this is different from the readfile function in the os 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) SetData ¶
func (obj *ReadFileFunc) SetData(data *interfaces.FuncData)
SetData is used by the language to pass our function some code-level context.
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.
Source Files