util

Documentation

Overview

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

Index

• func ConcatStrings(s ...string) string
• func HashBuffer(buf []byte) string
• func Waterfall(fns ...func() error) (err error)
• func WrapError(text string, err error) error
• type MessageBuffer
  • func (b *MessageBuffer) Flush() ([]byte, uint64)
  • func (b *MessageBuffer) Write(data []byte)
• type PausableTicker
  • func (p *PausableTicker) Pause()
  • func (p *PausableTicker) Start()
  • func (p *PausableTicker) StartIfPaused()

Functions

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 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

Types

type MessageBuffer

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

MessageBuffer provides bufferring and concatenation for post update messages

func (*MessageBuffer) Flush

func (b *MessageBuffer) Flush() ([]byte, uint64)

Flush flushes b into into a []byte and returns it together with the flushed message count. If no messages are stored, the returned buffer is nil.

func (*MessageBuffer) Write

func (b *MessageBuffer) Write(data []byte)

Write writes a message to b

type PausableTicker

type PausableTicker struct {
	C <-chan time.Time
	// contains filtered or unexported fields
}

PausableTicker is a time.Ticker that can be paused

func (*PausableTicker) Pause

func (p *PausableTicker) Pause()

Pause pauses p

func (*PausableTicker) Start

func (p *PausableTicker) Start()

Start starts p

func (*PausableTicker) StartIfPaused

func (p *PausableTicker) StartIfPaused()

StartIfPaused start p back up, if p is paused