Sentinel Errors and Error Wrapping/Unwrapping in Go with Code Examples

Advanced Error Handling in Go: Sentinel Errors, Wrapping, and Unwrapping

The video tutorial from Code and Learn focuses on advanced error handling techniques in Go, specifically covering sentinel errors, error wrapping, and error unwrapping with practical code examples.

---

Key Concepts and Features Covered

1. Sentinel Errors

• Sentinel errors are predefined, exported error variables used to signal specific, unique events in code (e.g., “no rows found” in a database query).
• Example: sql.ErrNoRows from the standard database/sql package is a sentinel error used to detect when a query returns no results.
• These errors are part of the package’s public API and must be maintained carefully.

2. Error Wrapping

• Wrapping adds context or additional information to an existing error without creating a new custom error type.
• The standard way to wrap errors in Go is using fmt.Errorf with the %w verb, which preserves the original error for later retrieval.
• %v can be used to add error strings without wrapping.
• Example code demonstrates wrapping an error returned from one function inside another error returned by a second function.

3. Error Joining

• Introduced in Go’s errors package, errors.Join can combine multiple errors into a single error object that implements unwrapping of multiple errors (returns a slice).
• errors.Join discards nil errors and concatenates error messages with new lines.

4. Error Unwrapping

• The errors.Unwrap function unwraps an error to reveal the underlying error it wraps, if any.
• It calls the Unwrap method on error types that implement it.
• Important: errors.Unwrap does not unwrap errors joined by errors.Join.
• The Go specification requires the Unwrap method to return either a single error or a slice of errors (for multiple wrapped errors). Returning nil means no wrapped error.

5. Custom Error Types with Unwrap

• The tutorial shows how to create a custom error struct that contains a message and a wrapped error.
• Implements the Error() method to satisfy the error interface.
• Implements the Unwrap() method to enable unwrapping of the wrapped error.
• Demonstrates calling errors.Unwrap on the custom error to retrieve the wrapped error.

6. Best Practices and Notes

• Wrapping errors with %w is preferred for adding context while preserving error chains.
• errors.Is and errors.As (to be covered in a future lesson) are better suited for checking sentinel errors in error chains than direct unwrapping.
• The unwrap function is rarely used directly but understanding it is key to working with wrapped errors.
• The tutorial encourages hands-on practice and reading official Go documentation for mastery.

---

Summary of Tutorial Structure

• Introduction to sentinel errors with real-world API example.
• Explanation and demonstration of error wrapping with fmt.Errorf and %w.
• Introduction to errors.Join for combining multiple errors.
• Explanation and examples of unwrapping errors using errors.Unwrap.
• Creating and using custom error types with an implemented Unwrap method.
• Recap of concepts and preview of next lesson on errors.Is and errors.As.

---

Main Speaker / Source

The tutorial is presented by the host of Code and Learn, who provides detailed explanations and live coding demonstrations throughout the video.

---

This video serves as a practical guide and tutorial for Go developers looking to deepen their understanding of error handling, particularly focusing on sentinel errors and the mechanics of wrapping and unwrapping errors in Go.