timeout

package

v0.7.0 Latest Latest Go to latest Published: Aug 10, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Package timeout 提供统一的超时执行包装:给任意函数加超时 + panic 恢复 + 错误分类。

比裸 context.WithTimeout 多:

典型场景:

纯标准库、并发安全(无状态)。

This section is empty.

View Source

var ErrPanic = &PanicError{}

ErrPanic 用于 errors.Is 判定 panic 类错误的哨兵值。

View Source

var ErrTimeout = errors.New("timeout: deadline exceeded")

ErrTimeout 表示执行超时。可用 errors.Is 判定。

func Do(ctx context.Context, d time.Duration, fn func(ctx context.Context) error) error

Do 在 timeout 内执行 fn。超时返回 ErrTimeout;fn panic 返回 *PanicError; 正常则返回 fn 的 error。

fn 运行在独立 goroutine 中;超时后 fn 仍在运行(Go 无法强杀 goroutine), 但调用方立即返回。如果需要 fn 配合退出,应在 fn 内检查 ctx。

func DoValue[T any](ctx context.Context, d time.Duration, fn func(ctx context.Context) (T, error)) (T, error)

DoValue 泛型版:超时内执行 fn 并返回结果 T。语义同 Do。

type PanicError struct {
	Value any
}

PanicError 表示 fn 内发生了 panic。

func (e *PanicError) Error() string

func (e *PanicError) Is(target error) bool

Is 支持 errors.Is(err, ErrPanic) 判定。