tmp

Documentation

Overview

Package tmp provides temporary files and directories.

Usage of this package requires eng approval - ask before using.

Index

• type Dir
  • func NewDir(options ...DirOption) (Dir, error)
• type DirOption
  • func DirWithBasePath(basePath string) DirOption
• type File
  • func NewFileWithData(data []byte) (File, error)

Types

type Dir

type Dir interface {
	io.Closer

	AbsPath() string
}

Dir is a temporary directory.

It must be closed when done.

func NewDir

func NewDir(options ...DirOption) (Dir, error)

NewDir returns a new temporary directory.

It must be closed when done. This file will be deleted on interrupt signals.

Usage of this function requires eng approval - ask before using.

type DirOption

type DirOption func(*dirOptions)

DirOption is an option for NewDir.

func DirWithBasePath

func DirWithBasePath(basePath string) DirOption

DirWithBasePath returns a new DirOption that sets the base path to create the temporary directory in.

The default is to use os.TempDir().

type File

type File interface {
	io.Closer

	AbsPath() string
}

File is a temporary file

It must be closed when done.

func NewFileWithData

func NewFileWithData(data []byte) (File, error)

NewFileWithData returns a new temporary file with the given data.

It must be closed when done. This file will be deleted on interrupt signals.

Usage of this function requires eng approval - ask before using.