context

Documentation

Overview

Package context contains helper utilities regarding go contexts.

Index

• Variables
• func IsContextError(err error) bool
• func IsDone(ctx interface{ ... }) bool
• func Terminates(timeout time.Duration, fn func()) bool
• func TerminatesCtx(ctx context.Context, fn func()) bool
• func TerminatesQuickly(fn func()) bool

Variables

var TerminatesQuicklyTimeout = 20 * time.Millisecond

TerminatesQuicklyTimeout is the timeout that TerminatesQuickly uses.

Functions

func IsContextError

func IsContextError(err error) bool

IsContextError returns whether the given error originates from a context that was cancelled or whose deadline exceeded. Prior to checking, the error is unwrapped by calling errors.Cause.

func IsDone

func IsDone(ctx interface{ Done() <-chan struct{} }) bool

IsDone returns whether ctx is done.

func Terminates

func Terminates(timeout time.Duration, fn func()) bool

Terminates checks whether a function terminates within a certain timeout.

func TerminatesCtx

func TerminatesCtx(ctx context.Context, fn func()) bool

TerminatesCtx checks whether a function terminates before a context is done.

func TerminatesQuickly

func TerminatesQuickly(fn func()) bool

TerminatesQuickly checks whether a function terminates within 20 ms.