Skip to main content

NestedLoadBuilder

Struct NestedLoadBuilder 

Source
pub struct NestedLoadBuilder<'ctx, 'builder> { /* private fields */ }
Expand description

A builder for loading nested assets inside a LoadContext.

Implementations§

Source§

impl<'ctx, 'builder> NestedLoadBuilder<'ctx, 'builder>

Source

pub fn with_settings<S: Settings>( self, settings: impl Fn(&mut S) + Send + Sync + 'static, ) -> Self

Use the given settings function to override the asset’s AssetLoader settings.

The type S must match the configured AssetLoader::Settings or settings changes will be ignored and an error will be printed to the log.

Repeatedly calling this method will “chain” the operations (matching the order of these calls).

Source

pub fn override_unapproved(self) -> Self

Loads from unapproved paths are allowed, even if AssetPlugin::unapproved_path_mode is Deny.

Source

pub fn load<'a, A: Asset>(self, path: impl Into<AssetPath<'a>>) -> Handle<A>

Loads the provided path as the given type and returns the handle.

This is a “deferred” load, meaning the caller will not have access to the loaded data; to access the loaded data, use Self::load_value.

Source

pub fn load_erased<'a>( self, type_id: TypeId, path: impl Into<AssetPath<'a>>, ) -> UntypedHandle

Loads the provided path as the given type and returns the handle.

This is a “deferred” load, meaning the caller will not have access to the loaded data; to access the loaded data, use Self::load_erased_value.

Source

pub fn load_untyped<'a>( self, path: impl Into<AssetPath<'a>>, ) -> Handle<LoadedUntypedAsset>

Loads the provided path with an unknown type (which is guessed based on the path or meta file).

This is a “deferred” load, meaning the caller will not have access to the loaded data; to access the loaded data, use Self::load_untyped_value.

Source

pub async fn load_value<'a, A: Asset>( self, path: impl Into<AssetPath<'a>>, ) -> Result<LoadedAsset<A>, LoadDirectError>

Loads the provided path as the given type, returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data.

Source

pub async fn load_erased_value<'a>( self, type_id: TypeId, path: impl Into<AssetPath<'a>>, ) -> Result<ErasedLoadedAsset, LoadDirectError>

Loads the provided path as the given type, returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data.

Source

pub async fn load_untyped_value<'a>( self, path: impl Into<AssetPath<'a>>, ) -> Result<ErasedLoadedAsset, LoadDirectError>

Loads the provided path with an unknown type (which is guessed based on the path or meta file), returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data.

Source

pub async fn load_value_from_reader<'a, A: Asset>( self, path: impl Into<AssetPath<'a>>, reader: &'builder mut dyn Reader, ) -> Result<LoadedAsset<A>, LoadDirectError>

Loads the given type from the given reader, returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data. The provided path determines the path used for handles of subassets, as well as any relative paths of assets used by the nested loader.

Source

pub async fn load_erased_value_from_reader<'a>( self, type_id: TypeId, path: impl Into<AssetPath<'a>>, reader: &'builder mut dyn Reader, ) -> Result<ErasedLoadedAsset, LoadDirectError>

Loads the given type from the given reader, returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data. The provided path determines the path used for handles of subassets, as well as any relative paths of assets used by the nested loader.

Source

pub async fn load_untyped_value_from_reader<'a>( self, path: impl Into<AssetPath<'a>>, reader: &'builder mut dyn Reader, ) -> Result<ErasedLoadedAsset, LoadDirectError>

Loads an asset from the given reader with an unknown type (which is guessed based on the path or meta file), returning the loaded data.

This load is async and therefore needs to be awaited before returning the loaded data. The provided path determines the path used for handles of subassets, as well as any relative paths of assets used by the nested loader.

Auto Trait Implementations§

§

impl<'ctx, 'builder> !RefUnwindSafe for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> !UnwindSafe for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> Freeze for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> Send for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> Sync for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> Unpin for NestedLoadBuilder<'ctx, 'builder>

§

impl<'ctx, 'builder> UnsafeUnpin for NestedLoadBuilder<'ctx, 'builder>

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<T> ConditionalSend for T
where T: Send,

Source§

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

Source§

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

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

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

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

Converts &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
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

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

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