scanner

Documentation

Overview

Package scanner provides an interface{} for scanning through a stream of bytes. The interface is compatible with bufio.Scanner.

Examples:

• https://godoc.org/bufio#Scanner

Index

• type Scanner
  • func New(reader io.Reader, separator byte, dropCR bool) Scanner

Types

type Scanner

type Scanner interface {
	Buffer(buf []byte, max int) // sets the initial buffer
	Scan() bool                 // advanced the scanner to the next block
	Bytes() []byte              // returns the bytes of the current block
	Text() string               // returns the text of the current block
}

Scanner is an interface compatible with bufio.Scanner that is used by iterators. By using this interface, we can support streams separated by null bytes, new-line characters, or any separator.

func New

func New(reader io.Reader, separator byte, dropCR bool) Scanner

New returns a new Scanner that reads from the given reader, splits on the given newLine byte, and drops carriage returns if indicated.