runtime

Documentation

Index

• func ContextWithOSSignalCancellation() context.Context
• type StackFrame
  • func Caller() *StackFrame
  • func Stack() []*StackFrame
  • func (f *StackFrame) Func() *runtime.Func
  • func (f *StackFrame) String() string

Functions

func ContextWithOSSignalCancellation

func ContextWithOSSignalCancellation() context.Context

ContextWithOSSignalCancellation builds a new Context that cancels itself on os.Interrupt signals.

Types

type StackFrame

type StackFrame struct {
	// The path to the file containing this ProgramCounter
	File string
	// The LineNumber in that file
	LineNumber int
	// The Name of the function that contains this ProgramCounter
	Name string
	// The Package that contains this function
	Package string
	// The underlying ProgramCounter
	ProgramCounter uintptr
}

A StackFrame contains all necessary information about to generate a line in a call stack.

func Caller

func Caller() *StackFrame

Caller returns the frame of the calling function.

func Stack

func Stack() []*StackFrame

Stack produces a stack trace for the current caller.

func (*StackFrame) Func

func (f *StackFrame) Func() *runtime.Func

Func returns the function that contained this frame.

func (*StackFrame) String

func (f *StackFrame) String() string

String is the string representation of a StackFrame.