atomicfile

Documentation

Overview

Package atomicfile defines file operations for safely writing files.

Index

• func SaveFile(ctx context.Context, o Object, t File) error
• type File
  • func New(filename string) File
• type Object

Functions

func SaveFile

func SaveFile(ctx context.Context, o Object, t File) error

SaveFile downloads object data and saves it to the given temp file.

Types

type File

type File interface {
	// Name returns the file name.
	Name() string
	// Create allocates a new safefile.File that writes to a temporary file.
	Create(perm os.FileMode) (*safefile.File, error)
	// Commit closes the underlying temporary file and renames it to the File.Name().
	Commit() error
}

A File abstracts operations on a temporary file.

func New

func New(filename string) File

New creates a new temporary File.

type Object

type Object interface {
	// Name returns the Object name.
	ObjectName() string
	// Copy writes the Object data to the given writer.
	Copy(ctx context.Context, w io.Writer) error
}

Object abstracts a data source.