27d02de375
# Objective - ECS error handling is a lovely flagship feature for Bevy 0.16, all in the name of reducing panics and encouraging better error handling (#14275). - Currently though, command and system error handling are completely disjoint and use different mechanisms. - Additionally, there's a number of distinct ways to set the default/fallback/global error handler that have limited value. As far as I can tell, this will be cfg flagged to toggle between dev and production builds in 99.9% of cases, with no real value in more granular settings or helpers. - Fixes #17272 ## Solution - Standardize error handling on the OnceLock global error mechanisms ironed out in https://github.com/bevyengine/bevy/pull/17215 - As discussed there, there are serious performance concerns there, especially for commands - I also think this is a better fit for the use cases, as it's truly global - Move from `SystemErrorContext` to a more general purpose `ErrorContext`, which can handle observers and commands more clearly - Cut the superfluous setter methods on `App` and `SubApp` - Rename the limited (and unhelpful) `fallible_systems` example to `error_handling`, and add an example of command error handling ## Testing Ran the `error_handling` example. ## Notes for reviewers - Do you see a clear way to allow commands to retain &mut World access in the per-command custom error handlers? IMO that's a key feature here (allowing the ad-hoc creation of custom commands), but I'm not sure how to get there without exploding complexity. - I've removed the feature gate on the default_error_handler: contrary to @cart's opinion in #17215 I think that virtually all apps will want to use this. Can you think of a category of app that a) is extremely performance sensitive b) is fine with shipping to production with the panic error handler? If so, I can try to gather performance numbers and/or reintroduce the feature flag. UPDATE: see benches at the end of this message. - ~~`OnceLock` is in `std`: @bushrat011899 what should we do here?~~ - Do you have ideas for more automated tests for this collection of features? ## Benchmarks I checked the impact of the feature flag introduced: benchmarks might show regressions. This bears more investigation. I'm still skeptical that there are users who are well-served by a fast always panicking approach, but I'm going to re-add the feature flag here to avoid stalling this out.  --------- Co-authored-by: Zachary Harrold <zac@harrold.com.au>
164 lines
5.1 KiB
TOML
164 lines
5.1 KiB
TOML
[package]
|
|
name = "bevy_ecs"
|
|
version = "0.16.0-dev"
|
|
edition = "2024"
|
|
description = "Bevy Engine's entity component system"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["ecs", "game", "bevy"]
|
|
categories = ["game-engines", "data-structures"]
|
|
rust-version = "1.85.0"
|
|
|
|
[features]
|
|
default = ["std", "bevy_reflect", "async_executor", "backtrace"]
|
|
|
|
# Functionality
|
|
|
|
## Enables multithreading support. Schedules will attempt to run systems on
|
|
## multiple threads whenever possible.
|
|
multi_threaded = ["bevy_tasks/multi_threaded", "dep:arrayvec"]
|
|
|
|
## Adds serialization support through `serde`.
|
|
serialize = [
|
|
"dep:serde",
|
|
"bevy_utils/serde",
|
|
"bevy_platform_support/serialize",
|
|
"indexmap/serde",
|
|
]
|
|
|
|
## Adds runtime reflection support using `bevy_reflect`.
|
|
bevy_reflect = ["dep:bevy_reflect"]
|
|
|
|
## Extends reflection support to functions.
|
|
reflect_functions = ["bevy_reflect", "bevy_reflect/functions"]
|
|
|
|
## Use the configurable global error handler as the default error handler.
|
|
##
|
|
## This is typically used to turn panics from the ECS into loggable errors.
|
|
## This may be useful for production builds,
|
|
## but can result in a measurable performance impact, especially for commands.
|
|
configurable_error_handler = []
|
|
|
|
## Enables automatic backtrace capturing in BevyError
|
|
backtrace = ["std"]
|
|
|
|
# Debugging Features
|
|
|
|
## Enables `tracing` integration, allowing spans and other metrics to be reported
|
|
## through that framework.
|
|
trace = ["std", "dep:tracing"]
|
|
|
|
## Enables a more detailed set of traces which may be noisy if left on by default.
|
|
detailed_trace = ["trace"]
|
|
|
|
## Provides system stepping support, allowing them to be paused, stepped, and
|
|
## other debug operations which can help with diagnosing certain behaviors.
|
|
bevy_debug_stepping = []
|
|
|
|
## Provides more detailed tracking of the cause of various effects within the ECS.
|
|
## This will often provide more detailed error messages.
|
|
track_location = []
|
|
|
|
# Executor Backend
|
|
|
|
## Uses `async-executor` as a task execution backend.
|
|
## This backend is incompatible with `no_std` targets.
|
|
async_executor = ["std", "bevy_tasks/async_executor"]
|
|
|
|
# Platform Compatibility
|
|
|
|
## Allows access to the `std` crate. Enabling this feature will prevent compilation
|
|
## on `no_std` targets, but provides access to certain additional features on
|
|
## supported platforms.
|
|
std = [
|
|
"bevy_reflect?/std",
|
|
"bevy_tasks/std",
|
|
"bevy_utils/std",
|
|
"bitflags/std",
|
|
"concurrent-queue/std",
|
|
"disqualified/alloc",
|
|
"fixedbitset/std",
|
|
"indexmap/std",
|
|
"serde?/std",
|
|
"nonmax/std",
|
|
"arrayvec?/std",
|
|
"log/std",
|
|
"bevy_platform_support/std",
|
|
]
|
|
|
|
## `critical-section` provides the building blocks for synchronization primitives
|
|
## on all platforms, including `no_std`.
|
|
critical-section = [
|
|
"bevy_tasks/critical-section",
|
|
"bevy_platform_support/critical-section",
|
|
"bevy_reflect?/critical-section",
|
|
]
|
|
|
|
[dependencies]
|
|
bevy_ptr = { path = "../bevy_ptr", version = "0.16.0-dev" }
|
|
bevy_reflect = { path = "../bevy_reflect", version = "0.16.0-dev", features = [
|
|
"smallvec",
|
|
], default-features = false, optional = true }
|
|
bevy_tasks = { path = "../bevy_tasks", version = "0.16.0-dev", default-features = false }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.16.0-dev", default-features = false, features = [
|
|
"alloc",
|
|
] }
|
|
bevy_ecs_macros = { path = "macros", version = "0.16.0-dev" }
|
|
bevy_platform_support = { path = "../bevy_platform_support", version = "0.16.0-dev", default-features = false, features = [
|
|
"alloc",
|
|
] }
|
|
|
|
bitflags = { version = "2.3", default-features = false }
|
|
concurrent-queue = { version = "2.5.0", default-features = false }
|
|
disqualified = { version = "1.0", default-features = false }
|
|
fixedbitset = { version = "0.5", default-features = false }
|
|
serde = { version = "1", default-features = false, features = [
|
|
"alloc",
|
|
"serde_derive",
|
|
], optional = true }
|
|
thiserror = { version = "2", default-features = false }
|
|
derive_more = { version = "1", default-features = false, features = [
|
|
"from",
|
|
"display",
|
|
"into",
|
|
"as_ref",
|
|
] }
|
|
nonmax = { version = "0.5", default-features = false }
|
|
arrayvec = { version = "0.7.4", default-features = false, optional = true }
|
|
smallvec = { version = "1", features = ["union", "const_generics"] }
|
|
indexmap = { version = "2.5.0", default-features = false }
|
|
variadics_please = { version = "1.1", default-features = false }
|
|
tracing = { version = "0.1", default-features = false, optional = true }
|
|
log = { version = "0.4", default-features = false }
|
|
bumpalo = "3"
|
|
|
|
[target.'cfg(not(all(target_has_atomic = "8", target_has_atomic = "16", target_has_atomic = "32", target_has_atomic = "64", target_has_atomic = "ptr")))'.dependencies]
|
|
concurrent-queue = { version = "2.5.0", default-features = false, features = [
|
|
"portable-atomic",
|
|
] }
|
|
|
|
[dev-dependencies]
|
|
rand = "0.8"
|
|
static_assertions = "1.1.0"
|
|
serde_test = "1.0"
|
|
|
|
[[example]]
|
|
name = "events"
|
|
path = "examples/events.rs"
|
|
|
|
[[example]]
|
|
name = "resources"
|
|
path = "examples/resources.rs"
|
|
|
|
[[example]]
|
|
name = "change_detection"
|
|
path = "examples/change_detection.rs"
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
|
|
all-features = true
|