scriptfile

Documentation

Index

• type ScriptFile
  • func New(l language.Language, name, script string) (*ScriptFile, error)
  • func NewAsSource(l language.Language, name, script string) (*ScriptFile, error)
  • func NewEmpty(l language.Language, name string) (*ScriptFile, error)
  • func (sf *ScriptFile) Clean()
  • func (sf *ScriptFile) Filename() string
  • func (sf *ScriptFile) Write(value string) error

Types

type ScriptFile

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

ScriptFile represents an on-disk executable file.

func New

func New(l language.Language, name, script string) (*ScriptFile, error)

New receives a language and script body that are used to construct a runable on-disk file that is tracked by the returned value.

func NewAsSource

func NewAsSource(l language.Language, name, script string) (*ScriptFile, error)

NewAsSource recieves a language and script body that are used to construct an on-disk file that is tracked by the return value. This file is not guaranteed to be runnable

func NewEmpty

func NewEmpty(l language.Language, name string) (*ScriptFile, error)

NewEmpty receives a language that is used to construct a runnable, but empty, on-disk file that is tracked by the return value.

func (*ScriptFile) Clean

func (sf *ScriptFile) Clean()

Clean provides simple/deferable clean up.

func (*ScriptFile) Filename

func (sf *ScriptFile) Filename() string

Filename returns the on-disk filename of the tracked script file.

func (*ScriptFile) Write

func (sf *ScriptFile) Write(value string) error

Write updates the on-disk scriptfile with the script value