safe

Documentation

Overview

Package safe provides safe file write semantics by leveraging Rename's() safeity.

Index

• type File
  • func CreateFile(filePath string) (*File, error)
  • func CreateFileWithPrefix(filePath string, prefix string) (*File, error)
  • func CreateFileWithSuffix(filePath string, suffix string) (*File, error)
  • func (f *File) Close() error
  • func (f *File) CloseAndRemove() error
  • func (f *File) SyncClose() error
• type Vault

Types

type File

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

File provides for safe file writes.

func CreateFile

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

CreateFile creates a new file at filePath for safe writes, it also creates parent directories if they don't exist.

func CreateFileWithPrefix

func CreateFileWithPrefix(filePath string, prefix string) (*File, error)

CreateFileWithPrefix creates a new file at filePath for safe writes, it also creates parent directories if they don't exist. prefix specifies the prefix of the temporary files so that cleaning stale temp files is easy.

func CreateFileWithSuffix

func CreateFileWithSuffix(filePath string, suffix string) (*File, error)

CreateFileWithSuffix is similar to CreateFileWithPrefix, but the second argument is treated as suffix for the temporary files.

func (*File) Close

func (f *File) Close() error

Close the file, returns an error if any

func (*File) CloseAndRemove

func (f *File) CloseAndRemove() error

CloseAndRemove closes the temp file, and safely removes it. Returns error if any.

func (*File) SyncClose

func (f *File) SyncClose() error

SyncClose sync file to disk and close, returns an error if any

type Vault

type Vault interface {
	io.ReadWriteCloser
	SyncClose() error
	CloseAndRemove() error
}

Vault - vault is an interface for different implementations of safe i/o semantics.