76e9bf9c99
# Objective - Contributes to #15460 - Reduce quantity and complexity of feature gates across Bevy ## Solution - Used `target_has_atomic` configuration variable to automatically detect impartial atomic support and automatically switch to `portable-atomic` over the standard library on an as-required basis. ## Testing - CI ## Notes To explain the technique employed here, consider getting `Arc` either from `alloc::sync` _or_ `portable-atomic-util`. First, we can inspect the `alloc` crate to see that you only have access to `Arc` _if_ `target_has_atomic = "ptr"`. We add a target dependency for this particular configuration _inverted_: ```toml [target.'cfg(not(target_has_atomic = "ptr"))'.dependencies] portable-atomic-util = { version = "0.2.4", default-features = false } ``` This ensures we only have the dependency when it is needed, and it is entirely excluded from the dependency graph when it is not. Next, we adjust our configuration flags to instead of checking for `feature = "portable-atomic"` to instead check for `target_has_atomic = "ptr"`: ```rust // `alloc` feature flag hidden for brevity #[cfg(not(target_has_atomic = "ptr"))] use portable_atomic_util as arc; #[cfg(target_has_atomic = "ptr")] use alloc::sync as arc; pub use arc::{Arc, Weak}; ``` The benefits of this technique are three-fold: 1. For platforms without full atomic support, the functionality is enabled automatically. 2. For platforms with atomic support, the dependency is never included, even if a feature was enabled using `--all-features` (for example) 3. The `portable-atomic` feature no longer needs to virally spread to all user-facing crates, it's instead something handled within `bevy_platform_support` (with some extras where other dependencies also need their features enabled).
136 lines
3.9 KiB
TOML
136 lines
3.9 KiB
TOML
[package]
|
|
name = "bevy_reflect"
|
|
version = "0.16.0-dev"
|
|
edition = "2024"
|
|
description = "Dynamically interact with rust types"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["bevy"]
|
|
rust-version = "1.85.0"
|
|
|
|
[features]
|
|
default = ["std", "smallvec", "debug"]
|
|
|
|
# Features
|
|
|
|
## When enabled, allows documentation comments to be accessed via reflection
|
|
documentation = ["bevy_reflect_derive/documentation"]
|
|
|
|
## Enables function reflection
|
|
functions = ["bevy_reflect_derive/functions"]
|
|
|
|
# When enabled, provides Bevy-related reflection implementations
|
|
bevy = ["smallvec", "smol_str"]
|
|
|
|
# Debugging Features
|
|
|
|
## Enables features useful for debugging reflection
|
|
debug = ["debug_stack"]
|
|
|
|
## When enabled, keeps track of the current serialization/deserialization context for better error messages
|
|
debug_stack = []
|
|
|
|
# Integrations
|
|
|
|
## Adds reflection support to `glam` types.
|
|
glam = ["dep:glam"]
|
|
|
|
## Adds reflection support to `petgraph` types.
|
|
petgraph = ["dep:petgraph", "std"]
|
|
|
|
## Adds reflection support to `smallvec` types.
|
|
smallvec = ["dep:smallvec"]
|
|
|
|
## Adds reflection support to `uuid` types.
|
|
uuid = ["dep:uuid"]
|
|
|
|
## Adds reflection support to `wgpu-types` types.
|
|
wgpu-types = ["dep:wgpu-types", "std"]
|
|
|
|
# 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_utils/std",
|
|
"erased-serde/std",
|
|
"downcast-rs/std",
|
|
"serde/std",
|
|
"glam?/std",
|
|
"smol_str?/std",
|
|
"uuid?/std",
|
|
"bevy_platform_support/std",
|
|
]
|
|
|
|
## `critical-section` provides the building blocks for synchronization primitives
|
|
## on all platforms, including `no_std`.
|
|
critical-section = [
|
|
"bevy_platform_support/critical-section",
|
|
"bevy_utils/critical-section",
|
|
]
|
|
|
|
[dependencies]
|
|
# bevy
|
|
bevy_reflect_derive = { path = "derive", version = "0.16.0-dev" }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.16.0-dev", default-features = false, features = [
|
|
"alloc",
|
|
] }
|
|
bevy_ptr = { path = "../bevy_ptr", version = "0.16.0-dev" }
|
|
bevy_platform_support = { path = "../bevy_platform_support", version = "0.16.0-dev", default-features = false, features = [
|
|
"alloc",
|
|
"serialize",
|
|
] }
|
|
|
|
# used by bevy-utils, but it also needs reflect impls
|
|
foldhash = { version = "0.1.3", default-features = false }
|
|
|
|
# other
|
|
erased-serde = { version = "0.4", default-features = false, features = [
|
|
"alloc",
|
|
] }
|
|
disqualified = { version = "1.0", default-features = false }
|
|
downcast-rs = { version = "2", default-features = false }
|
|
thiserror = { version = "2", default-features = false }
|
|
derive_more = { version = "1", default-features = false, features = ["from"] }
|
|
serde = { version = "1", default-features = false, features = ["alloc"] }
|
|
assert_type_match = "0.1.1"
|
|
smallvec = { version = "1.11", default-features = false, optional = true }
|
|
glam = { version = "0.29", default-features = false, features = [
|
|
"serde",
|
|
], optional = true }
|
|
petgraph = { version = "0.6", features = ["serde-1"], optional = true }
|
|
smol_str = { version = "0.2.0", default-features = false, features = [
|
|
"serde",
|
|
], optional = true }
|
|
uuid = { version = "1.13.1", default-features = false, optional = true, features = [
|
|
"v4",
|
|
"serde",
|
|
] }
|
|
variadics_please = "1.1"
|
|
wgpu-types = { version = "24", features = ["serde"], optional = true }
|
|
|
|
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
|
uuid = { version = "1.13.1", default-features = false, features = ["js"] }
|
|
|
|
[dev-dependencies]
|
|
ron = "0.8.0"
|
|
rmp-serde = "1.1"
|
|
bincode = "1.3"
|
|
serde_json = "1.0"
|
|
serde = { version = "1", features = ["derive"] }
|
|
static_assertions = "1.1.0"
|
|
|
|
[[example]]
|
|
name = "reflect_docs"
|
|
path = "examples/reflect_docs.rs"
|
|
required-features = ["documentation"]
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
|
|
all-features = true
|