cc69fdd0c6
# Objective - Fixes #15460 (will open new issues for further `no_std` efforts) - Supersedes #17715 ## Solution - Threaded in new features as required - Made certain crates optional but default enabled - Removed `compile-check-no-std` from internal `ci` tool since GitHub CI can now simply check `bevy` itself now - Added CI task to check `bevy` on `thumbv6m-none-eabi` to ensure `portable-atomic` support is still valid [^1] [^1]: This may be controversial, since it could be interpreted as implying Bevy will maintain support for `thumbv6m-none-eabi` going forward. In reality, just like `x86_64-unknown-none`, this is a [canary](https://en.wiktionary.org/wiki/canary_in_a_coal_mine) target to make it clear when `portable-atomic` no longer works as intended (fixing atomic support on atomically challenged platforms). If a PR comes through and makes supporting this class of platforms impossible, then this CI task can be removed. I however wager this won't be a problem. ## Testing - CI --- ## Release Notes Bevy now has support for `no_std` directly from the `bevy` crate. Users can disable default features and enable a new `default_no_std` feature instead, allowing `bevy` to be used in `no_std` applications and libraries. ```toml # Bevy for `no_std` platforms bevy = { version = "0.16", default-features = false, features = ["default_no_std"] } ``` `default_no_std` enables certain required features, such as `libm` and `critical-section`, and as many optional crates as possible (currently just `bevy_state`). For atomically-challenged platforms such as the Raspberry Pi Pico, `portable-atomic` will be used automatically. For library authors, we recommend depending on `bevy` with `default-features = false` to allow `std` and `no_std` users to both depend on your crate. Here are some recommended features a library crate may want to expose: ```toml [features] # Most users will be on a platform which has `std` and can use the more-powerful `async_executor`. default = ["std", "async_executor"] # Features for typical platforms. std = ["bevy/std"] async_executor = ["bevy/async_executor"] # Features for `no_std` platforms. libm = ["bevy/libm"] critical-section = ["bevy/critical-section"] [dependencies] # We disable default features to ensure we don't accidentally enable `std` on `no_std` targets, for example. bevy = { version = "0.16", default-features = false } ``` While this is verbose, it gives the maximum control to end-users to decide how they wish to use Bevy on their platform. We encourage library authors to experiment with `no_std` support. For libraries relying exclusively on `bevy` and no other dependencies, it may be as simple as adding `#![no_std]` to your `lib.rs` and exposing features as above! Bevy can also provide many `std` types, such as `HashMap`, `Mutex`, and `Instant` on all platforms. See `bevy::platform_support` for details on what's available out of the box! ## Migration Guide - If you were previously relying on `bevy` with default features disabled, you may need to enable the `std` and `async_executor` features. - `bevy_reflect` has had its `bevy` feature removed. If you were relying on this feature, simply enable `smallvec` and `smol_str` instead. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
136 lines
3.8 KiB
TOML
136 lines
3.8 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"]
|
|
|
|
# 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 = ["std"]
|
|
|
|
# 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"]
|
|
|
|
# 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",
|
|
"wgpu-types?/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, default-features = false }
|
|
|
|
[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
|