Skip to content

Support core::error in Rust 1.81 #463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shepmaster merged 2 commits into from
Sep 23, 2024
Merged

Support core::error in Rust 1.81 #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
493bd0e
Support core::error in Rust 1.81
shepmaster Aug 26, 2024
695247b
Rename `no_std_error` module to avoid confusion with core::error::Error
shepmaster Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .cirrus.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,20 +100,20 @@ stable_no_std_test_task:
- cargo build --no-default-features --target thumbv6m-none-eabi
before_cache_script: rm -rf $CARGO_HOME/registry/index

nightly_no_std_test_task:
name: "Rust Nightly (no_std)"
rust_1_81_no_std_test_task:
name: "Rust 1.81 (no_std)"
container:
image: rustlang/rust:nightly
image: rust:latest
cpu: 1
memory: 2Gi
cargo_cache:
folder: $CARGO_HOME/registry
fingerprint_script: cat Cargo.toml
setup_script:
- rustup target add thumbv6m-none-eabi --toolchain nightly
- rustup target add thumbv6m-none-eabi
core_error_test_script:
- rustc --version
- cargo +nightly build --no-default-features --features=unstable-core-error --target thumbv6m-none-eabi
- cargo build --no-default-features --features=rust_1_81 --target thumbv6m-none-eabi
before_cache_script: rm -rf $CARGO_HOME/registry/index

nightly_test_task:
Expand Down
3 changes: 3 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ rust_1_61 = ["snafu-derive/rust_1_61"]
# `Backtrace` was stabilized
rust_1_65 = ["rust_1_61"]

# `core::error` was stabilized
rust_1_81 = ["rust_1_65"]

# The backtrace type becomes `backtrace::Backtrace`
backtraces-impl-backtrace-crate = ["backtrace"]

Expand Down
0 src/no_std_error.rs → src/fallback_error.rs
View file
Open in desktop
File renamed without changes.
17 changes: 17 additions & 0 deletions src/guide/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,20 @@ the standard library is available and no other backtrace provider is
selected.

[`Backtrace`]: std::backtrace::Backtrace

## `rust_1_81`

<dl class="snafu-ff-meta">
<dt>Default</dt>
<dd>disabled</dd>
<dt>Implies</dt>
<dd>

[`rust_1_65`](#rust_1_65)

</dd>
</dl>

When enabled, SNAFU will assume that it's safe to target features
available in Rust 1.81. Notably, the [`core::error::Error`][] trait is
used instead of [`std::error::Error`][].
32 changes: 24 additions & 8 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,27 +338,43 @@ generate_guide! {
}
}

#[cfg(feature = "unstable-core-error")]
#[cfg(any(feature = "rust_1_81", feature = "unstable-core-error"))]
#[doc(hidden)]
pub use core::error;

#[cfg(feature = "unstable-core-error")]
#[cfg(any(feature = "rust_1_81", feature = "unstable-core-error"))]
#[doc(hidden)]
pub use core::error::Error;

#[cfg(all(not(feature = "unstable-core-error"), any(feature = "std", test)))]
#[cfg(all(
not(any(feature = "rust_1_81", feature = "unstable-core-error")),
any(feature = "std", test)
))]
#[doc(hidden)]
pub use std::error;

#[cfg(all(not(feature = "unstable-core-error"), any(feature = "std", test)))]
#[cfg(all(
not(any(feature = "rust_1_81", feature = "unstable-core-error")),
any(feature = "std", test)
))]
#[doc(hidden)]
pub use std::error::Error;

#[cfg(not(any(feature = "unstable-core-error", feature = "std", test)))]
mod no_std_error;
#[cfg(not(any(feature = "unstable-core-error", feature = "std", test)))]
#[cfg(not(any(
feature = "rust_1_81",
feature = "unstable-core-error",
feature = "std",
test
)))]
mod fallback_error;
#[cfg(not(any(
feature = "rust_1_81",
feature = "unstable-core-error",
feature = "std",
test
)))]
#[doc(hidden)]
pub use no_std_error::Error;
pub use fallback_error::Error;

/// Ensure a condition is true. If it is not, return from the function
/// with an error.
Expand Down