AtomicGo | timeout

Documentation | Contributing | Code of Conduct

go get atomicgo.dev/timeout

timeout

import "atomicgo.dev/timeout"

Package timeout provides a simple way to add timeouts to your Go code. The Execute function is blocking, so you can use it as a drop-in replacement for your function calls. Timeouts are often useful in scripts, where you want to limit the execution time of a function.

package main

import (
	"atomicgo.dev/timeout"
	"fmt"
	"time"
)

func main() {
	res, err := timeout.Execute(time.Second*2, func() (string, error) {
		time.Sleep(time.Second * 1)
		return "Hello, World!", nil
	})

	fmt.Println(res, err)
}

Hello, World! <nil>

package main

import (
	"atomicgo.dev/timeout"
	"fmt"
	"time"
)

func main() {
	res, err := timeout.Execute(time.Second*1, func() (string, error) {
		time.Sleep(time.Second * 2)
		return "Hello, World!", nil
	})

	fmt.Println(res, err)
}

timeout reached

package main

import (
	"atomicgo.dev/timeout"
	"errors"
	"fmt"
	"time"
)

func main() {
	res, err := timeout.Execute(time.Second*2, func() (string, error) {
		time.Sleep(time.Second * 1)
		return "", errors.New("some error") // nolint: goerr113
	})

	fmt.Println(res, err)
}

some error

Index

• Variables
• func Execute[T any](duration time.Duration, fn Function[T]) (T, error)
• type Function

Variables

ErrTimeoutReached is returned when the timeout is reached.

var ErrTimeoutReached = errors.New("timeout reached")

func Execute

func Execute[T any](duration time.Duration, fn Function[T]) (T, error)

Execute executes a function and returns the result or an error if the timeout is reached. If the timeout is reached, the Function will be interrupted. If the Function returns an error, the error will be returned.

type Function

Function is a function that returns a generic value and an error.

type Function[T any] func() (T, error)

Generated by gomarkdoc

AtomicGo.dev  ·  with ❤️ by @MarvinJWendt | MarvinJWendt.com