fswatcher

package

v1.1.0 Latest Latest Go to latest Published: May 28, 2023 License: Apache-2.0 Imports: 11 Imported by: 1

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/jdrews/go-tailer

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
func NewFile(orig *os.File, newPath string) (*os.File, error)
func NewLineReader() *lineReader
type Dir
- func (d *Dir) Path() string
type Error
- func NewError(errorType ErrorType, cause error, msg string) Error
- func NewErrorf(errorType ErrorType, cause error, format string, a ...interface{}) Error
type ErrorType
type FileTailer
- func RunFileTailer(globs []glob.Glob, readall bool, failOnMissingFile bool, ...) (FileTailer, error)
- func RunPollingFileTailer(globs []glob.Glob, readall bool, failOnMissingFile bool, ...) (FileTailer, error)
type Line

Constants ¶

View Source

const (
	NotSpecified = iota
	DirectoryNotFound
	FileNotFound

	// The WinFileRemoved Error should never be seen, because it is handled internally in the FileTailer.
	// TODO: Refactor error handling such that this is not part of the public interface.
	WinFileRemoved
)

Variables ¶

This section is empty.

Functions ¶

func NewFile ¶

func NewFile(orig *os.File, newPath string) (*os.File, error)

func NewLineReader ¶

func NewLineReader() *lineReader

Types ¶

type Dir ¶

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

On Linux, we don't need to keep the directory open, but we need to keep an open watch descriptor handle.

func (*Dir) Path ¶

func (d *Dir) Path() string

type Error ¶

type Error interface {
	Cause() error
	Type() ErrorType
	error
}

func NewError ¶

func NewError(errorType ErrorType, cause error, msg string) Error

func NewErrorf ¶

func NewErrorf(errorType ErrorType, cause error, format string, a ...interface{}) Error

type ErrorType ¶

type ErrorType int

type FileTailer ¶

type FileTailer interface {
	Lines() chan *Line
	Errors() chan Error
	Close()
}

func RunFileTailer ¶

func RunFileTailer(globs []glob.Glob, readall bool, failOnMissingFile bool, log logrus.FieldLogger) (FileTailer, error)

func RunPollingFileTailer ¶

func RunPollingFileTailer(globs []glob.Glob, readall bool, failOnMissingFile bool, pollInterval time.Duration, log logrus.FieldLogger) (FileTailer, error)

type Line ¶

type Line struct {
	Line  string
	File  string
	Extra interface{}
}

Source Files ¶

View all Source files

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