zecfoundation
/
thiserror-nostd-notrait
mirror of https://github.com/ZcashFoundation/thiserror-nostd-notrait.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Call out that we do not appear in public API

This commit is contained in:
David Tolnay 2019-10-09 13:04:28 -07:00
parent 86f6b3bc4a
commit 13e8352b67
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -44,6 +44,11 @@ pub enum DataStoreError {
## Details
- Thiserror deliberately does not appear in your public API. You get the same
thing as if you had written an implementation of `std::error::Error` by hand,
and switching from handwritten impls to thiserror or vice versa is not a
breaking change.
- Errors may be enums, structs with named fields, tuple structs, or unit
structs.

5
src/lib.rs
View File

@ -31,6 +31,11 @@
//!
//! # Details
//!
//! - Thiserror deliberately does not appear in your public API. You get the
//! same thing as if you had written an implementation of `std::error::Error`
//! by hand, and switching from handwritten impls to thiserror or vice versa
//! is not a breaking change.
//!
//! - Errors may be enums, structs with named fields, tuple structs, or unit
//! structs.
//!