atomic

Documentation

Overview

Package atomic provides atomic file write semantics by leveraging Rename's() atomicity.

Index

• type File
  • func FileCreate(filePath string) (*File, error)
  • func (f *File) Close() error
  • func (f *File) CloseAndPurge() error

Types

type File

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

File container provided for atomic file writes

func FileCreate

func FileCreate(filePath string) (*File, error)

FileCreate creates a new file at filePath for atomic writes, it also creates parent directories if they don't exist

func (*File) Close

func (f *File) Close() error

Close the file replacing, returns an error if any

func (*File) CloseAndPurge

func (f *File) CloseAndPurge() error

CloseAndPurge removes the temp file, closes the transaction and returns an error if any