a64446b77e
# Objective - Contributes to #16877 ## Solution - Initial creation of `bevy_platform_support` crate. - Moved `bevy_utils::Instant` into new `bevy_platform_support` crate. - Moved `portable-atomic`, `portable-atomic-util`, and `critical-section` into new `bevy_platform_support` crate. ## Testing - CI --- ## Showcase Instead of needing code like this to import an `Arc`: ```rust #[cfg(feature = "portable-atomic")] use portable_atomic_util::Arc; #[cfg(not(feature = "portable-atomic"))] use alloc::sync::Arc; ``` We can now use: ```rust use bevy_platform_support::sync::Arc; ``` This applies to many other types, but the goal is overall the same: allowing crates to use `std`-like types without the boilerplate of conditional compilation and platform-dependencies. ## Migration Guide - Replace imports of `bevy_utils::Instant` with `bevy_platform_support::time::Instant` - Replace imports of `bevy::utils::Instant` with `bevy::platform_support::time::Instant` ## Notes - `bevy_platform_support` hasn't been reserved on `crates.io` - ~~`bevy_platform_support` is not re-exported from `bevy` at this time. It may be worthwhile exporting this crate, but I am unsure of a reasonable name to export it under (`platform_support` may be a bit wordy for user-facing).~~ - I've included an implementation of `Instant` which is suitable for `no_std` platforms that are not Wasm for the sake of eliminating feature gates around its use. It may be a controversial inclusion, so I'm happy to remove it if required. - There are many other items (`spin`, `bevy_utils::Sync(Unsafe)Cell`, etc.) which should be added to this crate. I have kept the initial scope small to demonstrate utility without making this too unwieldy. --------- Co-authored-by: TimJentzsch <TimJentzsch@users.noreply.github.com> Co-authored-by: Chris Russell <8494645+chescock@users.noreply.github.com> Co-authored-by: François Mockers <francois.mockers@vleue.com>
145 lines
4.1 KiB
TOML
145 lines
4.1 KiB
TOML
[package]
|
|
name = "bevy_reflect"
|
|
version = "0.16.0-dev"
|
|
edition = "2021"
|
|
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.81.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",
|
|
"spin/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",
|
|
]
|
|
|
|
## `portable-atomic` provides additional platform support for atomic types and
|
|
## operations, even on targets without native support.
|
|
portable-atomic = [
|
|
"bevy_platform_support/portable-atomic",
|
|
"spin/portable_atomic",
|
|
"bevy_utils/portable-atomic",
|
|
]
|
|
|
|
[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",
|
|
] }
|
|
|
|
# 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"] }
|
|
spin = { version = "0.9.8", default-features = false, features = [
|
|
"once",
|
|
"rwlock",
|
|
] }
|
|
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.0", default-features = false, optional = true, features = [
|
|
"v4",
|
|
"serde",
|
|
] }
|
|
variadics_please = "1.1"
|
|
wgpu-types = { version = "23", features = ["serde"], optional = true }
|
|
|
|
[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
|