atomic

Documentation

Index

• func Compress(filename string) (string, error)
• func CompressType(filename string, ty string) (string, error)
• func Move(src, dst string) error
• func WriteFile(filename string, data []byte, perm os.FileMode) error
• type File
  • func New(path string, mode os.FileMode) (*File, error)
  • func (f *File) Abort() error
  • func (f *File) Close() error

Functions

func Compress

func Compress(filename string) (string, error)

Compress and return path to compressed file.

func CompressType

func CompressType(filename string, ty string) (string, error)

func Move

func Move(src, dst string) error

Move moves a file from a source path to a destination path This must be used across the codebase for compatibility with Docker volumes and Golang (fixes Invalid cross-device link when using os.Rename)

func WriteFile

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile writes the data to a temp file and atomically move if everything else succeeds.

Types

type File

type File struct {
	*os.File
	// contains filtered or unexported fields
}

File behaves like os.File, but does an atomic rename operation at Close.

func New

func New(path string, mode os.FileMode) (*File, error)

New creates a new temporary file that will replace the file at the given path when Closed.

func (*File) Abort

func (f *File) Abort() error

Abort closes the file and removes it instead of replacing the configured file. This is useful if after starting to write to the file you decide you don't want it anymore.

func (*File) Close

func (f *File) Close() error

Close the file replacing the configured file.