Export error fields - Githubissues

onflow / atree

Atree provides scalable arrays and scalable ordered maps.

https://onflow.org

Apache License 2.0

39 stars 16 forks source link

Closed turbolent closed 2 years ago

turbolent commented 2 years ago

Users of the library might want to use the error details, so export the error fields.

[x] Targeted PR against main branch
[ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work
[x] Code follows the standards mentioned here
[ ] Updated relevant documentation
[x] Re-reviewed Files changed in the Github PR explorer
[x] Added appropriate labels

fxamacker commented 2 years ago

I'm hesitant to export private error fields from Atree because:

renaming exported fields later (I've spotted some inconsistent naming) or changing their types could break compatibility with package using exported fields.
refactoring error handling to distinguish user and implementation errors after exporting private fields might require more work.

What do you think about creating getter functions to return specific error detail you currently need instead?

turbolent commented 2 years ago

Sounds good! I didn't end up needing the exported fields in Cadence, so we can just close the PR.