feat: add Metadata() method to export error context #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add public Metadata() method to *Error struct that returns a copy of metadata as map[string]any
- Include comprehensive tests for the new method including immutability verification
- Update README with documentation and usage examples for the Metadata() method
- Convert interface{} to any in tests for Go 1.18+ compatibility
This allows external consumers to inspect the structured context attached to errors while maintaining immutability and performance principles of the library.
There was a problem hiding this comment.
Pull request overview
This PR adds a Metadata() method to the *Error type, enabling external consumers to inspect structured context attached to errors. The method returns an immutable copy of the metadata as map[string]any, ensuring that modifications to the returned map don't affect the error's internal state.
Key changes:
- New
Metadata()method on*Errorthat returns a defensive copy of metadata - Comprehensive test coverage including immutability verification
- Documentation and usage examples added to README
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| zerr.go | Implements the new Metadata() method with defensive copying |
| zerr_test.go | Adds tests for metadata access and immutability; updates type from interface{} to any |
| README.md | Documents the new Metadata() method with usage examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows external consumers to inspect the structured context attached to errors while maintaining immutability and performance principles of the library.