util

Documentation

Index

• Variables
• func GetEnvOrDefault[T any](key string, defaultVal T, conversionFunc func(string) (T, error)) T
• func IsAppleSiliconMac(goos string, goarch string) bool
• func PickFreePort(minPort, maxPort int) (int, error)
• func SHA256HashFile(path string) (string, error)
• func SHA256HashFileWithSaltAndRange(path string, start int, end int, salt string) (string, error)
• func WrapError(err error, message string) error
• type RingBufferWriter
  • func NewRingBufferWriter(w io.Writer, size int) *RingBufferWriter
  • func (w *RingBufferWriter) String() string
  • func (w *RingBufferWriter) Write(p []byte) (n int, err error)

Variables

var (
	ErrInvalidRange = errors.New("Invalid byte range provided for file")
)

Functions

func GetEnvOrDefault

func GetEnvOrDefault[T any](key string, defaultVal T, conversionFunc func(string) (T, error)) T

GetEnvOrDefault returns an environment variable or a default if either the environment variable does not exist or fails to parse using the specified conversionFunc function

func IsAppleSiliconMac

func IsAppleSiliconMac(goos string, goarch string) bool

IsAppleSiliconMac returns whether the current machine is an Apple silicon computer, such as the MacBook Air with M1.

func PickFreePort

func PickFreePort(minPort, maxPort int) (int, error)

PickFreePort returns a TCP port in [min,max] that's not in use on the 127.0.0.1 interface. Note that there's a small chance of a race condition when a port is considered free at the time of the call, but not free when something tries to use it. This is good enough for dev and test code though.

func SHA256HashFile

func SHA256HashFile(path string) (string, error)

func SHA256HashFileWithSaltAndRange

func SHA256HashFileWithSaltAndRange(path string, start int, end int, salt string) (string, error)

func WrapError

func WrapError(err error, message string) error

WrapError is just a shortcut for using fmt.Errorf to wrap an error with a message

Types

type RingBufferWriter

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

RingBufferWriter is a writer that writes to an underlying writer and also maintains a ring buffer of the last N bytes written.

func NewRingBufferWriter

func NewRingBufferWriter(w io.Writer, size int) *RingBufferWriter

NewRingBufferWriter creates a new RingBufferWriter that writes to w and maintains a buffer of the last size bytes.

func (*RingBufferWriter) String

func (w *RingBufferWriter) String() string

String returns the contents of the ring buffer as a string

func (*RingBufferWriter) Write

func (w *RingBufferWriter) Write(p []byte) (n int, err error)

Write implements io.Writer interface