file

Documentation

Overview

Commands for reading and writing files.

Index

• type Commands
  • func New(scopeable utils.Scopeable) *Commands
  • func (self *Commands) Close(file *os.File) error
  • func (self *Commands) Create(filename string) (*os.File, error)
  • func (self *Commands) Open(filename string) (*os.File, error)
  • func (self *Commands) Read(source interface{}) (string, error)
  • func (self *Commands) Temp(args *TempArgs) (*os.File, error)
  • func (self *Commands) Write(destination interface{}, args *WriteArgs) error
• type TempArgs
• type WriteArgs

Types

type Commands

type Commands struct {
	utils.Module
	// contains filtered or unexported fields
}

func New

func New(scopeable utils.Scopeable) *Commands

func (*Commands) Close

func (self *Commands) Close(file *os.File) error

func (*Commands) Create

func (self *Commands) Create(filename string) (*os.File, error)

func (*Commands) Open

func (self *Commands) Open(filename string) (*os.File, error)

func (*Commands) Read

func (self *Commands) Read(source interface{}) (string, error)

func (*Commands) Temp

func (self *Commands) Temp(args *TempArgs) (*os.File, error)

func (*Commands) Write

func (self *Commands) Write(destination interface{}, args *WriteArgs) error

type TempArgs

type TempArgs struct {
	// A string to prefix temporary filenames with
	Prefix string `json:"prefix" default:"friendscript-"`
}

type WriteArgs

type WriteArgs struct {
	// The data to write as a stream.
	Data io.Reader `json:"data"`

	// The data to write as a discrete value.
	Value interface{} `json:"value"`

	// Whether to attempt to close the destination (if possible) after reading/writing.
	Autoclose bool `json:"autoclose" default:"true"`
}