gctx

Documentation

Overview

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

Index

• func New() context.Context
• func Value(ctx context.Context) string
• func WithCtx(ctx context.Context) context.Context
• func WithPrefix(ctx context.Context, prefix string) context.Context
• func WithValue(ctx context.Context, value string) context.Context
• type Ctx
• type StrKey

Functions

func New

func New() context.Context

New creates and returns a context which contains context id.

func Value

func Value(ctx context.Context) string

Value retrieves and returns the context id from context.

func WithCtx

func WithCtx(ctx context.Context) context.Context

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

func WithPrefix

func WithPrefix(ctx context.Context, prefix string) context.Context

WithPrefix creates and returns a context containing context id upon given parent context `ctx`. The generated context id has custom prefix string specified by parameter `prefix`.

func WithValue

func WithValue(ctx context.Context, value string) context.Context

WithValue creates and returns a context containing context id upon given parent context `ctx`. The generated context id value is specified by parameter `value`.

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.

const (
	// CtxKey is custom tracing context key for context id.
	// The context id a unique string for certain context.
	CtxKey StrKey = "GoFrameCtxId"
)