file

Documentation

Overview

Package file provides archive interface for local directories/files

Index

• func Delete(dir string, files []string) (err error)
• func List(dir string) (files []string, err error)
• type FileArchive
  • func NewArchive(outDir, prefix, extension string, options ...func(*common.BasicArchive) error) (rf *FileArchive, err error)
  • func OpenArchive(fileName string, bufferSize int) (rf *FileArchive, err error)

Functions

func Delete

func Delete(dir string, files []string) (err error)

func List

func List(dir string) (files []string, err error)

Types

type FileArchive

type FileArchive struct {
	common.BasicArchive
}

FileArchive embeds a BasicArchive with some additional attributes

func NewArchive

func NewArchive(outDir, prefix, extension string, options ...func(*common.BasicArchive) error) (rf *FileArchive, err error)

NewArchive creates a new recorder file (for writing). The caller must call `rf.Close()` on the resulting handle to close out the file. File is atomically renamed to the final name only after everything is flushed to disk and file is closed. `*FileArchive` returned is an io.Writer

func OpenArchive

func OpenArchive(fileName string, bufferSize int) (rf *FileArchive, err error)

OpenArchive opens an archive file for reading. `*FileArchive` returned is an io.Reader