paniccatcher

Documentation

Overview

Package paniccatcher package exposes a set of utility structures and methods that support standardized panic catching and handling.

Example

Example is a very simple example of how to use Catch to recover from a panic and log its stack trace.

Do(func() {
	fmt.Println("Doing something...")
	panic("Something wrong happened!")
}, func(p *Panic) {
	fmt.Println("Caught a panic:", p.Reason)
})

Output:

Doing something...
Caught a panic: Something wrong happened!

Index

• func Catch(cb func(p *Panic))
• func Do(f func(), cb func(p *Panic))
• type Panic
  • func (p *Panic) Log(ctx context.Context, fmt string, args ...any)

Examples

• Package

Functions

func Catch

func Catch(cb func(p *Panic))

Catch recovers from panic. It should be used as a deferred call.

If the supplied panic callback is nil, the panic will be silently discarded. Otherwise, the callback will be invoked with the panic's information.

func Do

func Do(f func(), cb func(p *Panic))

Do executes f. If a panic occurs during execution, the supplied callback will be called with the panic's information.

If the panic callback is nil, the panic will be caught and discarded silently.

Types

type Panic

type Panic struct {
	// Reason is the value supplied to the recover function.
	Reason any
	// Stack is a stack trace of where the panic happened.
	Stack string
}

Panic is a snapshot of a panic, containing both the panic's reason and the system stack.

func (*Panic) Log

func (p *Panic) Log(ctx context.Context, fmt string, args ...any)

Log logs the given message at error severity with the panic stack trace.