fileutil

Documentation

Overview

Helpers for working with files and filesystems

Index

• Constants
• Variables
• func AddMimeTypeFile(filename string)
• func ChecksumFile(filename string, fn interface{}) ([]byte, error)
• func CopyDir(root string, fn CopyEntryFunc) error
• func CopyFile(source interface{}, destination interface{}) error
• func GetMimeType(filenameOrReader interface{}, fallback ...string) string
• func InitMime()
• func IsModifiedAfter(stat os.FileInfo, current string) bool
• func IsTerminal() bool
• func MustExpandUser(path string) string
• func MustReadAll(filename string) []byte
• func MustReadAllString(filename string) string
• func MustWriteFile(reader io.Reader, filename string) int64
• func Open(uri string) (io.Reader, error)
• func OpenWithOptions(uri string, options OpenOptions) (io.Reader, error)
• func ReadAll(filename string) ([]byte, error)
• func ReadAllLines(filename string) ([]string, error)
• func ReadAllString(filename string) (string, error)
• func ReadFirstLine(filename string) (string, error)
• func RegisterOpenHandler(scheme string, handler OpenHandler)
• func RemoveOpenHandler(scheme string)
• func WriteFile(reader io.Reader, filename string) (int64, error)
• type CopyEntryFunc
• type DirReader
  • func NewDirReader(path string, options ...DirReaderOption) *DirReader
  • func (self *DirReader) Close() error
  • func (self *DirReader) Read(b []byte) (int, error)
  • func (self *DirReader) SetSkipFunc(fn SkipFunc)
• type DirReaderOption
• type DirReaderOptions
  • func (self DirReaderOptions) Has(option DirReaderOption) bool
• type OpenHandler
• type OpenOptions
  • func (self OpenOptions) GetTimeout() time.Duration
• type PostReadCloser
  • func NewPostReadCloser(upstream io.ReadCloser, closer func(io.ReadCloser) error) *PostReadCloser
  • func (self *PostReadCloser) Close() error
  • func (self *PostReadCloser) Read(b []byte) (int, error)
• type RewriteFileSystem
  • func (self RewriteFileSystem) Open(name string) (http.File, error)
• type SkipFunc

Constants

const DefaultOpenTimeout = time.Duration(10 * time.Second)

Variables

var DirExists = pathutil.DirExists

Alias functions from pathutil as a convenience

var Exists = pathutil.Exists

var ExpandUser = pathutil.ExpandUser

var FileExists = pathutil.FileExists

var IsAppend = pathutil.IsAppend

var IsAppendable = pathutil.IsAppendable

var IsCharDevice = pathutil.IsCharDevice

var IsDevice = pathutil.IsDevice

var IsExclusive = pathutil.IsExclusive

var IsNamedPipe = pathutil.IsNamedPipe

var IsNonemptyDir = pathutil.IsNonemptyDir

var IsNonemptyExecutableFile = pathutil.IsNonemptyExecutableFile

var IsNonemptyFile = pathutil.IsNonemptyFile

var IsReadable = pathutil.IsReadable

var IsSetgid = pathutil.IsSetgid

var IsSetuid = pathutil.IsSetuid

var IsSocket = pathutil.IsSocket

var IsSticky = pathutil.IsSticky

var IsSymlink = pathutil.IsSymlink

var IsTemporary = pathutil.IsTemporary

var IsWritable = pathutil.IsWritable

var LinkExists = pathutil.LinkExists

Functions

func AddMimeTypeFile

func AddMimeTypeFile(filename string)

func ChecksumFile

func ChecksumFile(filename string, fn interface{}) ([]byte, error)

func CopyDir

func CopyDir(root string, fn CopyEntryFunc) error

Recursively walk the entries of a given directory, calling CopyEntryFunc for each entry. The io.Writer returned from the function will have that file's contents written to it. If the io.Writer is nil, the file will not be written anywhere but no error will be returned. If CopyEntryFunc returns an error, the behavior will be consistent with filepath.WalkFunc

func CopyFile

func CopyFile(source interface{}, destination interface{}) error

Copy a file from one place to another. Source can be an io.Reader or string. If source is a string, the string will be passed to the Open() function as a URL. Destination can be an io.Writer or string. If destination is a string, it will be treated as a local filesystem path to write the data read from source to.

If either source or destination implements io.Closer, thee files will be closed before this function returns.

func GetMimeType

func GetMimeType(filenameOrReader interface{}, fallback ...string) string

GetMimeType goes out of its way to really, really try to figure out the MIME type of a given filename or io.Reader. If the first argument satisfies the io.Seeker interface, the seeker will Seek() back to the beginning. If it satisfies the io.Closer interface, it will be closed.

func InitMime

func InitMime()

func IsModifiedAfter

func IsModifiedAfter(stat os.FileInfo, current string) bool

Return true if the given FileInfo sports a ModTime later than the current file.

func IsTerminal

func IsTerminal() bool

func MustExpandUser

func MustExpandUser(path string) string

func MustReadAll

func MustReadAll(filename string) []byte

func MustReadAllString

func MustReadAllString(filename string) string

func MustWriteFile

func MustWriteFile(reader io.Reader, filename string) int64

Same as WriteFile, but will panic if the file cannot be written.

func Open

func Open(uri string) (io.Reader, error)

Calls OpenWithOptions with no options set.

func OpenWithOptions

func OpenWithOptions(uri string, options OpenOptions) (io.Reader, error)

A generic URL opener that supports various schemes and returns an io.Reader. Supported URL schemes include: file://, http://, https://, ftp://, sftp://. If no scheme is provided, the URL is interpreted as a local filesystem path.

func ReadAll

func ReadAll(filename string) ([]byte, error)

func ReadAllLines

func ReadAllLines(filename string) ([]string, error)

func ReadAllString

func ReadAllString(filename string) (string, error)

func ReadFirstLine

func ReadFirstLine(filename string) (string, error)

func RegisterOpenHandler

func RegisterOpenHandler(scheme string, handler OpenHandler)

Register a handler for a new or existing URL scheme, for use with Open() and OpenWithOptions()

func RemoveOpenHandler

func RemoveOpenHandler(scheme string)

Removes a registered URL scheme handler.

func WriteFile

func WriteFile(reader io.Reader, filename string) (int64, error)

Write the contents of the given reader to the specified filename. Filename paths containing tilde (~) will automatically expand to the current user's home directory, and all intermediate parent directories will be automatically created. Will return the number of bytes written, or an error.

Types

type CopyEntryFunc

type CopyEntryFunc func(path string, info os.FileInfo, err error) (io.Writer, error)

type DirReader

type DirReader struct {
	// contains filtered or unexported fields
}

A DirReader provides a streaming io.Reader interface to all files in a given directory, with options for handling unreadable entries and recursion.

func NewDirReader

func NewDirReader(path string, options ...DirReaderOption) *DirReader

func (*DirReader) Close

func (self *DirReader) Close() error

close open files and reset the internal reader

func (*DirReader) Read

func (self *DirReader) Read(b []byte) (int, error)

func (*DirReader) SetSkipFunc

func (self *DirReader) SetSkipFunc(fn SkipFunc)

Set a function that will be called for each path encountered while reading. If this function returns true, that path (and its descedants) will not be read.

type DirReaderOption

type DirReaderOption int

const (
	NoRecursive DirReaderOption = iota
	FailOnError
)

type DirReaderOptions

type DirReaderOptions []DirReaderOption

func (DirReaderOptions) Has

func (self DirReaderOptions) Has(option DirReaderOption) bool

type OpenHandler

type OpenHandler func(*url.URL, OpenOptions) (io.ReadCloser, error)

type OpenOptions

type OpenOptions struct {
	Timeout  time.Duration
	Insecure bool
}

func (OpenOptions) GetTimeout

func (self OpenOptions) GetTimeout() time.Duration

type PostReadCloser

type PostReadCloser struct {
	// contains filtered or unexported fields
}

func NewPostReadCloser

func NewPostReadCloser(upstream io.ReadCloser, closer func(io.ReadCloser) error) *PostReadCloser

Implements an io.ReadCloser that can be configured to perform cleanup options whenever the Close() function is called.

func (*PostReadCloser) Close

func (self *PostReadCloser) Close() error

func (*PostReadCloser) Read

func (self *PostReadCloser) Read(b []byte) (int, error)

type RewriteFileSystem

type RewriteFileSystem struct {
	FileSystem http.FileSystem
	Find       *regexp.Regexp
	Replace    string
	MustMatch  bool
}

func (RewriteFileSystem) Open

func (self RewriteFileSystem) Open(name string) (http.File, error)

type SkipFunc

type SkipFunc func(string) bool