04990fcd27
# Objective - Contributes to #16877 ## Solution - Expanded `bevy_platform_support::sync` module to provide API-compatible replacements for `std` items such as `RwLock`, `Mutex`, and `OnceLock`. - Removed `spin` from all crates except `bevy_platform_support`. ## Testing - CI --- ## Notes - The sync primitives, while verbose, entirely rely on `spin` for their implementation requiring no `unsafe` and not changing the status-quo on _how_ locks actually work within Bevy. This is just a refactoring to consolidate the "hacks" and workarounds required to get a consistent experience when either using `std::sync` or `spin`. - I have opted to rely on `std::sync` for `std` compatible locks, maintaining the status quo. However, now that we have these locks factored out into the own module, it would be trivial to investigate alternate locking backends, such as `parking_lot`. - API for these locking types is entirely based on `std`. I have implemented methods and types which aren't currently in use within Bevy (e.g., `LazyLock` and `Once`) for the sake of completeness. As the standard library is highly stable, I don't expect the Bevy and `std` implementations to drift apart much if at all. --------- Co-authored-by: BD103 <59022059+BD103@users.noreply.github.com> Co-authored-by: Benjamin Brienen <benjamin.brienen@outlook.com> |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
Bevy Platform Support
Rust is a fantastic multi-platform language with extensive support for modern targets through its standard library.
However, some items within the standard library have alternatives that are better suited for Bevy and game engines in general.
Additionally, to support embedded and other esoteric platforms, it's often necessary to shed reliance on std, making your crate no_std.
These needs are handled by this crate, bevy_platform_support.
The goal of this crate is to provide alternatives and extensions to the Rust standard library which minimize friction when developing with and for Bevy across multiple platforms.
Getting Started
Like any dependency from crates.io, use cargo to add it to your Cargo.toml file:
cargo add bevy_platform_support
Now, instead of importing from std you can use bevy_platform_support for items it has alternative for.
See the documentation for what items are available, and explanations for why you may want to use them.
no_std Support
By default, bevy_platform_support will activate the std feature, requiring access to the std crate for whichever platforms you're targeting.
To use this crate on no_std platforms, disable default features:
bevy_platform_support = { version = "x.y.z", default-features = false }
Features
std (default)
Enables usage of the standard library. Note that where this crate has alternatives to the standard library that it considers better than what's provided, it will provide the alternative even when std is enabled.
This is explicitly incompatible with no_std targets.
alloc (default)
Enables usage of the alloc crate. Note that this feature is automatically enabled when enabling std.
This is compatible with most no_std targets, but not all.
portable-atomic
Switches to using portable-atomic as a backend for atomic types, such as Arc, AtomicU8, etc.
You may need to enable this feature on platforms without full support for atomic types or certain operations, such as atomic CAS.
critical-section
Switches to using critical-section as a backend for synchronization.
You may need to enable this feature on platforms with little to no support for atomic operations, and is often paired with the portable-atomic feature.