lineio

Documentation

Index

• Variables
• type Line
  • func (l Line) Copy() Line
• type Scanner
  • func NewScanner(fd *os.File, buf []byte, opts ...ScannerOption) Scanner
  • func (s Scanner) Err() error
  • func (s Scanner) Line() Line
  • func (s *Scanner) ResumeFromEOF() (bool, error)
  • func (s *Scanner) Scan() bool
• type ScannerOption
  • func WithStartPos(startingByte int64, startingLine int) ScannerOption
• type Tailer
  • func NewTailer(fd io.ReadSeeker, buf []byte) *Tailer
  • func (t *Tailer) Tail(ctx context.Context, backoff time.Duration, consume func([]Line) error) error

Variables

var ErrEndOfTail error = errors.New("end of tail")

var ErrLineTooLong error = errors.New("a line doesnot fit in the buffer")

Types

type Line

type Line struct {
	// No is the number of current line, starting from 1
	No int
	// LineStart is the start offset of current line in the File, in number of bytes, staring from 0
	LineStart int64
	// LineEnding is the ending offset of current line in the File, in number of bytes, staring from 0, pointing at current \n
	LineEnding int64
	// Raw holds the line content, excluding \n
	Raw []byte
}

func (Line) Copy

func (l Line) Copy() Line

type Scanner

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

func NewScanner

func NewScanner(fd *os.File, buf []byte, opts ...ScannerOption) Scanner

func (Scanner) Err

func (s Scanner) Err() error

func (Scanner) Line

func (s Scanner) Line() Line

func (*Scanner) ResumeFromEOF

func (s *Scanner) ResumeFromEOF() (bool, error)

func (*Scanner) Scan

func (s *Scanner) Scan() bool

type ScannerOption

type ScannerOption func(*Scanner)

func WithStartPos

func WithStartPos(startingByte int64, startingLine int) ScannerOption

type Tailer

type Tailer struct {
	StartingByte int64
	StartingLine int
	// contains filtered or unexported fields
}

func NewTailer

func NewTailer(fd io.ReadSeeker, buf []byte) *Tailer

func (*Tailer) Tail

func (t *Tailer) Tail(ctx context.Context, backoff time.Duration, consume func([]Line) error) error