atomic

package

v0.1.361 Latest Latest Go to latest Published: Feb 9, 2024 License: GPL-3.0 Imports: 8 Imported by: 0

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/miku/span

Links

Open Source Insights

Documentation ¶

Index ¶

func Compress(filename string) (string, error)
func CompressType(filename string, ty string) (string, error)
func Move(src, dst string) error
func WriteFile(filename string, data []byte, perm os.FileMode) error
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 ¶

func Compress ¶ added in v0.1.333

func Compress(filename string) (string, error)

Compress and return path to compressed file.

func CompressType ¶ added in v0.1.334

func CompressType(filename string, ty string) (string, error)

func Move ¶ added in v0.1.333

func Move(src, dst string) error

Move moves a file from a source path to a destination path This must be used across the codebase for compatibility with Docker volumes and Golang (fixes Invalid cross-device link when using os.Rename)

func WriteFile ¶

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile writes the data to a temp file and atomically move if everything else succeeds.

Types ¶

type File ¶ added in v0.1.333

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 ¶ added in v0.1.333

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 ¶ added in v0.1.333

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 ¶ added in v0.1.333

func (f *File) Close() error

Close the file replacing the configured file.

Source Files ¶

View all Source files

file.go

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