Package renameio provides a way to atomically create or replace a file or symbolic link.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.travis.yml
CONTRIBUTING.md Initial commit Oct 30, 2018
LICENSE Initial commit Oct 30, 2018
README.md
doc.go rename package to renameio Nov 7, 2018
example_test.go
go.mod
symlink_test.go rename package to renameio Nov 7, 2018
tempfile.go fix TempDir fallback Nov 8, 2018
tempfile_linux_test.go rename package to renameio Nov 7, 2018
writefile.go add WriteFile (#7) Nov 8, 2018
writefile_test.go add WriteFile (#7) Nov 8, 2018

README.md

Build Status GoDoc Go Report Card

The renameio Go package provides a way to atomically create or replace a file or symbolic link.

Advantages of this package

There are other packages for atomically replacing files, and sometimes ad-hoc implementations can be found in programs.

A naive approach to the problem is to create a temporary file followed by a call to os.Rename(). However, there are a number of subtleties which make the correct sequence of operations hard to identify:

  • The temporary file should be removed when an error occurs, but a remove must not be attempted if the rename succeeded, as a new file might have been created with the same name. This renders a throwaway defer os.Remove(t.Name()) insufficient; state must be kept.

  • The temporary file must be created on the same file system (same mount point) for the rename to work, but the TMPDIR environment variable should still be respected, e.g. to direct temporary files into a separate directory outside of the webserver’s document root but on the same file system.

  • On POSIX operating systems, the fsync system call must be used to ensure that the os.Rename() call will not result in a 0-length file.

This package attempts to get all of these details right, provides an intuitive, yet flexible API and caters to use-cases where high performance is required.

Disclaimer

This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.

This project is not affiliated with the Go project.