gctx

Documentation

Overview

Package gctx wraps context.Context and provides extra context features.

Index

• func CtxId(ctx context.Context) string
• func GetInitCtx() context.Context
• func NeverDone(ctx context.Context) context.Context
• func New() context.Context
• func SetInitCtx(ctx context.Context)
• func WithCtx(ctx context.Context) context.Context
• type Ctx
• type StrKey

Functions

func CtxId

func CtxId(ctx context.Context) string

CtxId retrieves and returns the context id from context.

func GetInitCtx

func GetInitCtx() context.Context

GetInitCtx returns the initialization context. Initialization context is used in `main` or `init` functions.

func NeverDone

func NeverDone(ctx context.Context) context.Context

NeverDone wraps and returns a new context object that will be never done, which forbids the context manually done, to make the context can be propagated to asynchronous goroutines.

Note that, it does not affect the closing (canceling) of the parent context, as it is a wrapper for its parent, which only affects the next context handling.

func New

func New() context.Context

New creates and returns a context which contains context id.

func SetInitCtx

func SetInitCtx(ctx context.Context)

SetInitCtx sets custom initialization context. Note that this function cannot be called in multiple goroutines.

func WithCtx

func WithCtx(ctx context.Context) context.Context

WithCtx creates and returns a context containing context id upon given parent context `ctx`.

Types

type Ctx

type Ctx = context.Context // Ctx is short name alias for context.Context.

type StrKey

type StrKey string // StrKey is a type for warps basic type string as context key.