util

Documentation

Overview

Package util contains various general utility functions used throughout the project.

Index

• func CloneBytes(b []byte) []byte
• func ConcatStrings(s ...string) string
• func HashBuffer(buf []byte) string
• func Parallel(fns ...func() error) error
• func SplitPunctuation(word []byte) (leading byte, mid []byte, trailing byte)
• func SplitPunctuationString(word string) (leading byte, mid string, trailing byte)
• func Waterfall(fns ...func() error) (err error)
• func WrapError(text string, err error) error

Functions

func CloneBytes

func CloneBytes(b []byte) []byte

CloneBytes creates a copy of b

func ConcatStrings

func ConcatStrings(s ...string) string

ConcatStrings efficiently concatenates strings with only one extra allocation

func HashBuffer

func HashBuffer(buf []byte) string

HashBuffer computes a base64 MD5 hash from a buffer

func Parallel

func Parallel(fns ...func() error) error

Execute functions in parallel. The first error is returned, if any.

func SplitPunctuation

func SplitPunctuation(word []byte) (leading byte, mid []byte, trailing byte)

SplitPunctuation splits off one byte of leading and trailing punctuation, if any, and returns the 3 split parts. If there is no edge punctuation, the respective byte = 0.

func SplitPunctuationString

func SplitPunctuationString(word string) (
	leading byte, mid string, trailing byte,
)

SplitPunctuationString splits off one byte of leading and trailing punctuation, if any, and returns the 3 split parts. If there is no edge punctuation, the respective byte = 0.

func Waterfall

func Waterfall(fns ...func() error) (err error)

Waterfall executes a slice of functions until the first error returned. This error, if any, is returned to the caller.

func WrapError

func WrapError(text string, err error) error

WrapError wraps error types to create compound error chains