Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Catcher ¶
type Catcher struct {
// contains filtered or unexported fields
}
Catcher is used to catch panics. You can execute a function with Try, which will catch any spawned panic. Try can be called any number of times, from any number of goroutines. Once all calls to Try have completed, you can get the value of the first panic (if any) with Recovered(), or you can just propagate the panic (re-panic) with Repanic().
Example ¶
package main
import (
"fmt"
"github.com/GoCarnival/conc/panics"
)
func main() {
var pc panics.Catcher
i := 0
pc.Try(func() { i += 1 })
pc.Try(func() { panic("abort!") })
pc.Try(func() { i += 1 })
rc := pc.Recovered()
fmt.Println(i)
fmt.Println(rc.Value.(string))
}
Output: 2 abort!
Example (Callers) ¶
package main
import (
"fmt"
"runtime"
"github.com/GoCarnival/conc/panics"
)
func main() {
var pc panics.Catcher
pc.Try(func() { panic("mayday!") })
recovered := pc.Recovered()
// For debugging, the pre-formatted recovered.Stack is easier to use than
// rc.Callers. This is not used in the example because its output is
// machine-specific.
frames := runtime.CallersFrames(recovered.Callers)
for {
frame, more := frames.Next()
fmt.Println(frame.Function)
if !more {
break
}
}
}
Output: github.com/GoCarnival/conc/panics.(*Catcher).tryRecover runtime.gopanic github.com/GoCarnival/conc/panics_test.ExampleCatcher_callers.func1 github.com/GoCarnival/conc/panics.(*Catcher).Try github.com/GoCarnival/conc/panics_test.ExampleCatcher_callers testing.runExample testing.runExamples testing.(*M).Run main.main runtime.main runtime.goexit
Example (Error) ¶
package main
import (
"errors"
"fmt"
"github.com/GoCarnival/conc/panics"
)
func main() {
helper := func() error {
var pc panics.Catcher
pc.Try(func() { panic(errors.New("error")) })
return pc.Recovered().AsError()
}
if err := helper(); err != nil {
// In normal use cases, you can use err.Error() output directly to
// dump the panic's stack. This is not used in the example because
// its output is machine-specific - instead, we demonstrate getting
// the underlying error that was used for the panic.
if cause := errors.Unwrap(err); cause != nil {
fmt.Printf("helper panicked with an error: %s", cause)
}
}
}
Output: helper panicked with an error: error
func (*Catcher) Recovered ¶
Recovered returns the value of the first panic caught by Try, or nil if no calls to Try panicked.
type ErrRecovered ¶
type ErrRecovered struct{ Recovered }
ErrRecovered wraps a panics.Recovered in an error implementation.
func (*ErrRecovered) Error ¶
func (p *ErrRecovered) Error() string
func (*ErrRecovered) Unwrap ¶
func (p *ErrRecovered) Unwrap() error
type Recovered ¶
type Recovered struct {
// The original value of the panic.
Value any
// The caller list as returned by runtime.Callers when the panic was
// recovered. Can be used to produce a more detailed stack information with
// runtime.CallersFrames.
Callers []uintptr
// The formatted stacktrace from the goroutine where the panic was recovered.
// Easier to use than Callers.
Stack []byte
}
Recovered is a panic that was caught with recover().
func NewRecovered ¶
NewRecovered creates a panics.Recovered from a panic value and a collected stacktrace. The skip parameter allows the caller to skip stack frames when collecting the stacktrace. Calling with a skip of 0 means include the call to NewRecovered in the stacktrace.
func Try ¶
func Try(f func()) *Recovered
Try executes f, catching and returning any panic it might spawn.
The recovered panic can be propagated with panic(), or handled as a normal error with (*panics.Recovered).AsError().
Source Files