26d6145915
# Objective Partially address #3492. ## Solution Document the remaining undocumented members of `bevy_utils` and set `warn(missing_docs)` on the crate level. Also enabled `clippy::undocumented_unsafe_blocks` as a warning on the crate to keep it in sync with `bevy_ecs`'s warnings.
44 lines
1.6 KiB
Rust
44 lines
1.6 KiB
Rust
//! A reimplementation of the currently unstable [`std::sync::Exclusive`]
|
|
//!
|
|
//! [`std::sync::Exclusive`]: https://doc.rust-lang.org/nightly/std/sync/struct.Exclusive.html
|
|
|
|
/// See [`Exclusive`](https://github.com/rust-lang/rust/issues/98407) for stdlib's upcoming implementation,
|
|
/// which should replace this one entirely.
|
|
///
|
|
/// Provides a wrapper that allows making any type unconditionally [`Sync`] by only providing mutable access.
|
|
#[repr(transparent)]
|
|
pub struct SyncCell<T: ?Sized> {
|
|
inner: T,
|
|
}
|
|
|
|
impl<T: Sized> SyncCell<T> {
|
|
/// Construct a new instance of a `SyncCell` from the given value.
|
|
pub fn new(inner: T) -> Self {
|
|
Self { inner }
|
|
}
|
|
|
|
/// Deconstruct this `SyncCell` into its inner value.
|
|
pub fn to_inner(Self { inner }: Self) -> T {
|
|
inner
|
|
}
|
|
}
|
|
|
|
impl<T: ?Sized> SyncCell<T> {
|
|
/// Get a reference to this `SyncCell`'s inner value.
|
|
pub fn get(&mut self) -> &mut T {
|
|
&mut self.inner
|
|
}
|
|
|
|
/// Build a mutable reference to a `SyncCell` from a mutable reference
|
|
/// to its inner value, to skip constructing with [`new()`](SyncCell::new()).
|
|
pub fn from_mut(r: &'_ mut T) -> &'_ mut SyncCell<T> {
|
|
// SAFETY: repr is transparent, so refs have the same layout; and `SyncCell` properties are `&mut`-agnostic
|
|
unsafe { &mut *(r as *mut T as *mut SyncCell<T>) }
|
|
}
|
|
}
|
|
|
|
// SAFETY: `Sync` only allows multithreaded access via immutable reference.
|
|
// As `SyncCell` requires an exclusive reference to access the wrapped value,
|
|
// marking this type as `Sync` does not actually allow threaded access to the inner value.
|
|
unsafe impl<T: ?Sized> Sync for SyncCell<T> {}
|