atomicfile

package module

v0.0.0-...-2de1f20 Latest Latest Go to latest Published: Oct 19, 2015 License: BSD-3-Clause Imports: 3 Imported by: 50

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/facebookgo/atomicfile

Links

Open Source Insights

README ¶

atomicfile

Documentation: https://godoc.org/github.com/facebookgo/atomicfile

NOTE: This package uses os.Rename, which may or may not be atomic on your operating system. It is known to not be atomic on Windows. https://github.com/natefinch/atomic provides a similar library that is atomic on Windows as well and may be worth investigating.

Documentation ¶

Overview ¶

Package atomicfile provides the ability to write a file with an eventual rename on Close (using os.Rename). This allows for a file to always be in a consistent state and never represent an in-progress write.

NOTE: `os.Rename` may not be atomic on your operating system.

Index ¶

type File
- func New(path string, mode os.FileMode) (*File, error)
- func (f *File) Abort() error
- func (f *File) Close() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

atomicfile.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL