9bc0ae33c3
# Objective - Contributes to #16877 ## Solution - Moved `hashbrown`, `foldhash`, and related types out of `bevy_utils` and into `bevy_platform_support` - Refactored the above to match the layout of these types in `std`. - Updated crates as required. ## Testing - CI --- ## Migration Guide - The following items were moved out of `bevy_utils` and into `bevy_platform_support::hash`: - `FixedState` - `DefaultHasher` - `RandomState` - `FixedHasher` - `Hashed` - `PassHash` - `PassHasher` - `NoOpHash` - The following items were moved out of `bevy_utils` and into `bevy_platform_support::collections`: - `HashMap` - `HashSet` - `bevy_utils::hashbrown` has been removed. Instead, import from `bevy_platform_support::collections` _or_ take a dependency on `hashbrown` directly. - `bevy_utils::Entry` has been removed. Instead, import from `bevy_platform_support::collections::hash_map` or `bevy_platform_support::collections::hash_set` as appropriate. - All of the above equally apply to `bevy::utils` and `bevy::platform_support`. ## Notes - I left `PreHashMap`, `PreHashMapExt`, and `TypeIdMap` in `bevy_utils` as they might be candidates for micro-crating. They can always be moved into `bevy_platform_support` at a later date if desired.
87 lines
2.8 KiB
Rust
87 lines
2.8 KiB
Rust
use crate::io::{AssetReader, AssetReaderError, PathStream, Reader};
|
|
use alloc::{boxed::Box, sync::Arc};
|
|
use bevy_platform_support::collections::HashMap;
|
|
use crossbeam_channel::{Receiver, Sender};
|
|
use parking_lot::RwLock;
|
|
use std::path::Path;
|
|
|
|
/// A "gated" reader that will prevent asset reads from returning until
|
|
/// a given path has been "opened" using [`GateOpener`].
|
|
///
|
|
/// This is built primarily for unit tests.
|
|
pub struct GatedReader<R: AssetReader> {
|
|
reader: R,
|
|
gates: Arc<RwLock<HashMap<Box<Path>, (Sender<()>, Receiver<()>)>>>,
|
|
}
|
|
|
|
impl<R: AssetReader + Clone> Clone for GatedReader<R> {
|
|
fn clone(&self) -> Self {
|
|
Self {
|
|
reader: self.reader.clone(),
|
|
gates: self.gates.clone(),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Opens path "gates" for a [`GatedReader`].
|
|
pub struct GateOpener {
|
|
gates: Arc<RwLock<HashMap<Box<Path>, (Sender<()>, Receiver<()>)>>>,
|
|
}
|
|
|
|
impl GateOpener {
|
|
/// Opens the `path` "gate", allowing a _single_ [`AssetReader`] operation to return for that path.
|
|
/// If multiple operations are expected, call `open` the expected number of calls.
|
|
pub fn open<P: AsRef<Path>>(&self, path: P) {
|
|
let mut gates = self.gates.write();
|
|
let gates = gates
|
|
.entry_ref(path.as_ref())
|
|
.or_insert_with(crossbeam_channel::unbounded);
|
|
gates.0.send(()).unwrap();
|
|
}
|
|
}
|
|
|
|
impl<R: AssetReader> GatedReader<R> {
|
|
/// Creates a new [`GatedReader`], which wraps the given `reader`. Also returns a [`GateOpener`] which
|
|
/// can be used to open "path gates" for this [`GatedReader`].
|
|
pub fn new(reader: R) -> (Self, GateOpener) {
|
|
let gates = Arc::new(RwLock::new(HashMap::default()));
|
|
(
|
|
Self {
|
|
reader,
|
|
gates: gates.clone(),
|
|
},
|
|
GateOpener { gates },
|
|
)
|
|
}
|
|
}
|
|
|
|
impl<R: AssetReader> AssetReader for GatedReader<R> {
|
|
async fn read<'a>(&'a self, path: &'a Path) -> Result<impl Reader + 'a, AssetReaderError> {
|
|
let receiver = {
|
|
let mut gates = self.gates.write();
|
|
let gates = gates
|
|
.entry_ref(path.as_ref())
|
|
.or_insert_with(crossbeam_channel::unbounded);
|
|
gates.1.clone()
|
|
};
|
|
receiver.recv().unwrap();
|
|
let result = self.reader.read(path).await?;
|
|
Ok(result)
|
|
}
|
|
|
|
async fn read_meta<'a>(&'a self, path: &'a Path) -> Result<impl Reader + 'a, AssetReaderError> {
|
|
self.reader.read_meta(path).await
|
|
}
|
|
|
|
async fn read_directory<'a>(
|
|
&'a self,
|
|
path: &'a Path,
|
|
) -> Result<Box<PathStream>, AssetReaderError> {
|
|
self.reader.read_directory(path).await
|
|
}
|
|
|
|
async fn is_directory<'a>(&'a self, path: &'a Path) -> Result<bool, AssetReaderError> {
|
|
self.reader.is_directory(path).await
|
|
}
|
|
}
|