Skip to main content

Assets

Struct Assets 

Source
pub struct Assets<T: AssetSource> { /* private fields */ }
Expand description

Unified storage for source and processed assets of type T.

Each entry holds both the raw source data (T) and the uploaded result (T::Processed), keyed by the same Handle<T>. AssetPlugin fills in processed after a successful Asset::upload.

Use get to retrieve the processed result (e.g. for rendering), and get_source to access the raw data.

Implementations§

Source§

impl<T: AssetSource> Assets<T>

Source

pub fn new() -> Self

Source

pub fn insert(&mut self, name: &str, source: T) -> Handle<T>

Insert source under name, returning its handle.

If an asset with the same name already exists, its source data is replaced in-place (the same handle is reused and re-queued for re-upload), and any previously processed result is cleared.

Source

pub fn get(&self, handle: Handle<T>) -> Option<&T::Processed>

Look up the processed (uploaded) asset for handle.

Returns None if the handle is null, stale, or the asset has not finished uploading yet.

Source

pub fn get_source(&self, handle: Handle<T>) -> Option<&T>

Look up the raw source data for handle.

Source

pub fn get_source_mut(&mut self, handle: Handle<T>) -> Option<&mut T>

Mutably look up the raw source data for handle.

Source

pub fn is_ready(&self, handle: Handle<T>) -> bool

Returns true if handle exists and its processed asset is ready. Never logs — safe to poll speculatively.

Source

pub fn contains(&self, handle: Handle<T>) -> bool

Returns true if handle currently refers to a present entry. Never logs — safe to poll speculatively.

Source

pub fn get_by_name(&self, name: &str) -> Option<&T::Processed>

Look up the processed asset by the name it was inserted under. None if the name is unknown or the asset hasn’t uploaded yet — not logged, since “still uploading” is a normal transient state.

Source

pub fn get_source_by_name(&self, name: &str) -> Option<&T>

Look up the raw source data by the name it was inserted under.

Source

pub fn get_handle_by_name(&self, name: &str) -> Option<Handle<T>>

Look up a handle by name.

Source

pub fn replace(&mut self, handle: Handle<T>, source: T) -> bool

Replace the source data for handle, invalidating the processed result and re-queuing for upload. Returns false if the handle is null or not present.

Source

pub fn mark_dirty(&mut self, handle: Handle<T>)

Mark a single asset as dirty so the sync system re-uploads it next tick, even though its source data has not changed (e.g. a dependency was recreated). Does nothing if the handle is null or not present.

Source

pub fn remove(&mut self, handle: Handle<T>) -> Option<T>

Remove an asset by handle, returning the source value if it existed. The processed asset is also discarded.

Source

pub fn remove_by_name(&mut self, name: &str) -> Option<T>

Remove an asset by name, returning the source value if it existed.

Source

pub fn iter(&self) -> impl Iterator<Item = (RawAssetHandle, &T::Processed)>

Iterate over all entries that have a processed result ready.

Source

pub fn iter_source(&self) -> impl Iterator<Item = (RawAssetHandle, &T)>

Iterate over all source entries regardless of upload state.

Source

pub fn names(&self) -> impl Iterator<Item = (&str, RawAssetHandle)>

Iterate over (name, handle) pairs for every named asset.

Auto Trait Implementations§

§

impl<T> Freeze for Assets<T>

§

impl<T> RefUnwindSafe for Assets<T>

§

impl<T> Send for Assets<T>

§

impl<T> Sync for Assets<T>

§

impl<T> Unpin for Assets<T>
where T: Unpin, <T as AssetSource>::Processed: Unpin,

§

impl<T> UnsafeUnpin for Assets<T>

§

impl<T> UnwindSafe for Assets<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more