file

Documentation

Overview

File IO commands

Index

• type Commands
  • func New(browser *browser.Browser, env utils.Scopeable) *Commands
  • func (self *Commands) Write(destination interface{}, args *WriteArgs) (*WriteResponse, error)
• type WriteArgs
• type WriteResponse

Types

type Commands

type Commands struct {
	*file.Commands
	// contains filtered or unexported fields
}

func New

func New(browser *browser.Browser, env utils.Scopeable) *Commands

func (*Commands) Write

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

Write a value or a stream of data to a file at the given path. The destination path can be a local filesystem path, a URI that uses a custom scheme registered outside of the application, or the string "temporary", which will write to a temporary file whose path will be returned in the response.

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"`
}

type WriteResponse

type WriteResponse struct {
	// The filesystem path that the data was written to.
	Path string `json:"path,omitempty"`

	// The size of the data (in bytes).
	Size int64 `json:"size,omitempty"`
}