go-error-checking
Type-safe error inspection using errors.Is and errors.As
When & Why to Use This Skill
This Claude skill provides a comprehensive guide for implementing type-safe error inspection in Go using the standard library's errors.Is and errors.As functions. It helps developers avoid common pitfalls associated with error wrapping and direct type assertions, ensuring robust and maintainable error handling logic in Golang applications.
Use Cases
- Sentinel Error Detection: Using errors.Is to reliably check for specific error values (like database 'not found' errors) even when they have been wrapped with additional context.
- Custom Error Extraction: Utilizing errors.As to safely extract specific error types from a wrapped error chain to access detailed metadata, such as validation failure fields or filesystem path errors.
- Code Modernization: Refactoring legacy Go codebases to replace brittle '==' comparisons and manual type assertions with modern, wrap-aware error handling patterns to improve reliability.
| name | go-error-checking |
|---|---|
| description | Type-safe error inspection using errors.Is and errors.As |
Error Checking
Pattern
Use errors.Is to check sentinel errors and errors.As to extract error types.
errors.Is - Check Sentinel Errors
// CORRECT
if errors.Is(err, user.ErrNotFound) {
return http.StatusNotFound
}
// WRONG - breaks with wrapped errors
if err == user.ErrNotFound { }
errors.As - Extract Error Types
// CORRECT - extracts specific error type
var pathErr *fs.PathError
if errors.As(err, &pathErr) {
log.Printf("failed path: %s", pathErr.Path)
log.Printf("operation: %s", pathErr.Op)
}
// WRONG - only checks direct type
if pathErr, ok := err.(*fs.PathError); ok { }
Complete Example
func HandleError(err error) {
// Check sentinel errors
if errors.Is(err, user.ErrNotFound) {
fmt.Println("User not found")
return
}
// Extract custom error types
var validationErr *ValidationError
if errors.As(err, &validationErr) {
fmt.Printf("Validation failed: %v\n", validationErr.Fields)
return
}
// Extract standard library errors
var pathErr *fs.PathError
if errors.As(err, &pathErr) {
fmt.Printf("File operation failed: %s\n", pathErr.Path)
return
}
// Generic error
fmt.Printf("Unknown error: %v\n", err)
}
Key Differences
errors.Is: Checks if error matches a sentinel value (works through wrapping)errors.As: Extracts error of specific type (works through wrapping)- Never use
==or type assertions for wrapped errors