fileutil

Documentation

Overview

Package fileutil provides file utility functions, complementing the lower level abstractions found in the standard library.

Index

• func CopyFileUpTo(dst io.Writer, fname string, maxBytes int64) error
• func Getwd() string
• func IsReadableFile(path string) (bool, error)
• func ReadFileUpTo(fname string, maxSize int64) ([]byte, error)
• type Watcher
  • func NewWatcher() *Watcher
  • func (watcher *Watcher) Watch(ctx context.Context, filePaths []string)

Functions

func CopyFileUpTo

func CopyFileUpTo(dst io.Writer, fname string, maxBytes int64) error

CopyFileUpTo copies content of the file up to maxBytes it returns an error if file is larger than allowed maximum

func Getwd

func Getwd() string

Getwd returns a rooted path name corresponding to the current directory. If the current directory can be reached via multiple paths (due to symbolic links), Getwd may return any one of them.

On failure, will return "."

func IsReadableFile

func IsReadableFile(path string) (bool, error)

IsReadableFile reports whether the file exists and is readable. If the error is non-nil, it means there might be a file or directory with that name but we cannot read it.

Adapted from the upspin.io source code.

func ReadFileUpTo

func ReadFileUpTo(fname string, maxSize int64) ([]byte, error)

ReadFileUpTo reads file up to given size it returns an error if file is larger than allowed maximum

Types

type Watcher

type Watcher struct {
	*signal.Signal
	// contains filtered or unexported fields
}

A Watcher watches files for changes.

func NewWatcher

func NewWatcher() *Watcher

NewWatcher creates a new Watcher.

func (*Watcher) Watch

func (watcher *Watcher) Watch(ctx context.Context, filePaths []string)

Watch updates the watched file paths.