scope

README

scope

scope is a substitute for the Go context package.

It provides a more convenient context API than the standard library, while maintaining 100% compatibility.

Requirements

The minimum Go version is go1.23.

Install

The forms package can be added to a project with go get.

go get -u cattlecloud.net/go/scope@latest

License

The cattlecloud.net/go/scope module is open source under the BSD license.

Documentation

Overview

Package scope implements a simplified and more convenient API for creating context.Context values with often used functionality like timeouts.

Index

• func Cancelable() (C, Cancel)
• func TTL(duration time.Duration) (C, Cancel)
• func WithCancel(c C) (C, Cancel)
• func WithTTL(c C, duration time.Duration) (C, Cancel)
• type C
  • func New() C
• type Cancel

Functions

func Cancelable

func Cancelable() (C, Cancel)

Cancelable will create a fresh context not part of any preceding chain of values, and includes a Cancel function.

func TTL

func TTL(duration time.Duration) (C, Cancel)

TTL will create a fresh context not part of any preceding chain of values, and will expire after the given duration.

func WithCancel

func WithCancel(c C) (C, Cancel)

WithCancel wraps an existing Context with a Cancel function.

func WithTTL

func WithTTL(c C, duration time.Duration) (C, Cancel)

WithTTL wraps an existing Context that will expire after the given duration.

Types

type C

type C = context.Context

C is an alias for context.Context

func New

func New() C

New will create a fresh context not part of any preceding chain of values.

type Cancel

type Cancel = context.CancelFunc

Cancel is an alias for context.CancelFunc