splitter

Documentation

Overview

Package splitter provides a wrapper for creating a custom bufio.SplitFunc.

Reference:

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

Index

• func DropCarriageReturn(data []byte) []byte
• func ScanDocuments(separator []byte, dropCR bool) bufio.SplitFunc
• func ScanLines(separator byte, dropCR bool) bufio.SplitFunc

Functions

func DropCarriageReturn

func DropCarriageReturn(data []byte) []byte

DropCarriageReturn drops the final byte of the slice if it is a carriage return.

Examples:

• DropCarriageReturn([]byte("abc\r")) == []byte("abc")
• DropCarriageReturn([]byte("abc")) == []byte("abc")

func ScanDocuments

func ScanDocuments(separator []byte, dropCR bool) bufio.SplitFunc

ScanDocuments returns a function that splits a stream of bytes on the given separator byte slice and whether to drop line-ending carriage returns. Returns a new bufio.SplitFunc compatible with bufio.Scanner

Examples:

• ScanDocuments([]byte("---\n")[0], true) - split on YAML boundary marker and drop carriage returns at the end of a line.

func ScanLines

func ScanLines(separator byte, dropCR bool) bufio.SplitFunc

ScanLines returns a function that splits a stream of bytes on the given separator character and whether to drop line-ending carriage returns. Returns a new bufio.SplitFunc compatible with bufio.Scanner

Examples:

• ScanLines([]byte("\n")[0], true) - split on new lines and drop carriage returns at the end of a line.
• ScanLines(byte(0), false) - split on null byte