follow

Documentation

Overview

Package follow provides Reader which follows file updates and turns it into a stream.

Index

• type Reader
  • func NewReader(readCtx context.Context, source *os.File) *Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Read(p []byte) (n int, err error)

Types

type Reader

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

Reader implements io.ReadCloser over regular file following file contents.

This makes file similar to the stream in semantics.

func NewReader

func NewReader(readCtx context.Context, source *os.File) *Reader

NewReader wraps io.File as follow.Reader.

func (*Reader) Close

func (r *Reader) Close() error

Close implements io.Closer interface.

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, err error)

Read implements io.Reader interface.