tmp

Documentation

Overview

Package tmp provides temporary files and directories.

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

Index

• type DirOption
  • func DirWithBasePath(basePath string) DirOption
• type File
  • func NewDir(ctx context.Context, options ...DirOption) (File, error)
  • func NewFile(ctx context.Context, reader io.Reader) (File, error)

Types

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

	Path() string
}

File is a temporary file or directory.

It must be closed when done.

func NewDir

func NewDir(ctx context.Context, options ...DirOption) (File, error)

NewDir returns a new temporary directory.

It must be closed when done. This deletes this directory and all its contents. This directory will be automatically closed on context cancellation.

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

func NewFile

func NewFile(ctx context.Context, reader io.Reader) (File, error)

NewFile returns a new temporary file with the data copied from the Reader.

It must be closed when done. This deletes this file. This file will be automatically closed on context cancellation.

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