itsscb/eyre
1
0
Fork 0
mirror of https://github.com/eyre-rs/eyre.git synced 2025-10-02 07:21:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation on no_std support. (#111)

Browse Source 
no_std support was removed in 2020 with PR #29. This change updates the documentation to reflect that as suggested in PR #89. It still mentions no_std, which will hopefully keep it on our minds enough to check sometimes and see if the upstream problem has been resolved.

Co-authored-by: Jane Losare-Lusby <jlusby@yaah.dev>
This commit is contained in:
nori li 2023-11-07 13:46:13 -08:00 committed by GitHub
parent 7fefca5981
commit 2ec1dff66d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -171,23 +171,9 @@ avoid using `eyre::Report` as your public error type.
## No-std support ## No-std support
**NOTE**: tests are currently broken for `no_std` so I cannot guarantee that No-std support was removed in 2020 in [commit 608a16a] due to unaddressed upstream breakages.
everything works still. I'm waiting for upstream fixes to be merged rather than [commit 608a16a]:
fixing them myself, so bear with me. https://github.com/eyre-rs/eyre/pull/29/commits/608a16aa2c2c27eca6c88001cc94c6973c18f1d5
In no_std mode, the same API is almost all available and works the same way. To
depend on Eyre in no_std mode, disable our default enabled "std" feature in
Cargo.toml. A global allocator is required.
```toml
[dependencies]
eyre = { version = "0.6", default-features = false }
```
Since the `?`-based error conversions would normally rely on the
`std::error::Error` trait which is only available through std, no_std mode will
require an explicit `.map_err(Report::msg)` when working with a non-Eyre error
type inside a function that returns Eyre's error type.
## Comparison to failure ## Comparison to failure

20
eyre/src/lib.rs
View File

@ -236,23 +236,9 @@
//! //!
//! ## No-std support //! ## No-std support
//! //!
//! **NOTE**: tests are currently broken for `no_std` so I cannot guarantee that //! No-std support was removed in 2020 in [commit 608a16a] due to unaddressed upstream breakages.
//! everything works still. I'm waiting for upstream fixes to be merged rather than //! [commit 608a16a]:
//! fixing them myself, so bear with me. //! https://github.com/eyre-rs/eyre/pull/29/commits/608a16aa2c2c27eca6c88001cc94c6973c18f1d5
//!
//! In no_std mode, almost all the API is available and works the same way. To
//! depend on Eyre in no_std mode, disable our default enabled "std" feature in
//! Cargo.toml. A global allocator is required.
//!
//! ```toml
//! [dependencies]
//! eyre = { version = "0.6", default-features = false }
//! ```
//!
//! Since the `?`-based error conversions would normally rely on the
//! `std::error::Error` trait which is only available through std, no_std mode will
//! require an explicit `.map_err(Report::msg)` when working with a non-Eyre error
//! type inside a function that returns Eyre's error type.
//! //!
//! ## Comparison to failure //! ## Comparison to failure
//! //!