files

Documentation

Overview

Package files contains file-related utilities.

Index

• type Writer
  • func NewWriter(file string) *Writer
  • func (w *Writer) Cleanup()
  • func (w *Writer) Close() error
  • func (w *Writer) Write(p []byte) (int, error)

Types

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer writes a sequence of bytes to a file. In case of errors, the old file contents remain untouched since the writes are applied atomically when the Writer is closed.

func NewWriter

func NewWriter(file string) *Writer

NewWriter returns a writer that writes to the named files.

The caller should eventually call Cleanup. A recommended pattern is:

w := files.NewWriter(dst)
defer w.Cleanup()
... write to w ...
err := w.Close()

func (*Writer) Cleanup

func (w *Writer) Cleanup()

Cleanup releases any resources in use by the writer, without attempting to write collected bytes to the destination. It is safe to call Cleanup() even if Close or Cleanup have already been called.

func (*Writer) Close

func (w *Writer) Close() error

Close saves the written bytes to the destination file and closes the writer. Close returns an error if any errors were encountered, including during earlier Write calls.

func (*Writer) Write

func (w *Writer) Write(p []byte) (int, error)

Write writes p and returns the number of bytes written, which will either be len(p), or the returned error will be non-nil.