pub struct CacheQueue { /* private fields */ }Expand description
Resource holding queued asset-save requests.
Assets can be enqueued in two ways:
-
enqueue_reflect— pass any value that implementsReflect. The value will be serialized to RON via Bevy’sReflectSerializerusing theAppTypeRegistry. The type must be registered in the type registry (viaapp.register_type::<T>()) and should haveReflectSerializetype data (derived automatically for types that implement bothReflectandserde::Serialize). -
enqueue— pass any [Read]er containing pre-serialized data and a file extension. No reflection or registry required. Usestd::io::Cursorin tests or for in-memory data.
Enqueued entries are processed by [process_pending_saves] which runs
each frame in PostUpdate.
Implementations§
Source§impl CacheQueue
impl CacheQueue
Sourcepub fn enqueue_reflect(
&mut self,
value: Box<dyn Reflect>,
key: impl Into<String>,
extension: impl Into<String>,
max_age: Option<Duration>,
)
pub fn enqueue_reflect( &mut self, value: Box<dyn Reflect>, key: impl Into<String>, extension: impl Into<String>, max_age: Option<Duration>, )
Enqueue a reflected value for caching.
The value will be serialized to RON using Bevy’s
ReflectSerializer during [process_pending_saves].
The type must be registered in the AppTypeRegistry.
§Example
#[derive(Asset, TypePath, Reflect, serde::Serialize)]
#[reflect(Serialize)]
struct LevelData { tiles: Vec<u32> }
fn cache_level(
mut pending: ResMut<CacheQueue>,
assets: Res<Assets<LevelData>>,
handle: Res<MyLevelHandle>,
) {
if let Some(level) = assets.get(&handle.0) {
pending.enqueue_reflect(
Box::new(level.clone()),
"level_01",
"ron",
None,
);
}
}Sourcepub fn enqueue<R: Read + Send + Sync + 'static>(
&mut self,
key: impl Into<String>,
extension: impl Into<String>,
reader: R,
max_age: Option<Duration>,
)
pub fn enqueue<R: Read + Send + Sync + 'static>( &mut self, key: impl Into<String>, extension: impl Into<String>, reader: R, max_age: Option<Duration>, )
Enqueue a [Read]er for caching.
The caller is responsible for serialization; the data is streamed
as-is to {key}.{extension} in the cache directory without buffering
the entire payload in memory.
Use std::io::Cursor to wrap in-memory buffers:
§Example
fn cache_screenshot(mut pending: ResMut<CacheQueue>) {
let png_bytes: Vec<u8> = capture_screenshot();
pending.enqueue("scene_01", "png", std::io::Cursor::new(png_bytes), None);
}Trait Implementations§
Source§impl Default for CacheQueue
impl Default for CacheQueue
Source§fn default() -> CacheQueue
fn default() -> CacheQueue
impl Resource for CacheQueue
Auto Trait Implementations§
impl Freeze for CacheQueue
impl !RefUnwindSafe for CacheQueue
impl Send for CacheQueue
impl Sync for CacheQueue
impl Unpin for CacheQueue
impl UnsafeUnpin for CacheQueue
impl !UnwindSafe for CacheQueue
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more