Skip to main content

LoadContext

Struct LoadContext 

Source
pub struct LoadContext<'a> { /* private fields */ }
Expand description

Context provided to asset loaders during loading.

The context provides:

  • The path of the asset being loaded
  • Methods to declare dependencies on other assets
  • Metadata about the loading process

Loaders call add_dependency to declare that the asset being loaded depends on another asset. After loading completes, the AssetServer records these edges in the dependency graph so that cascade reloads work correctly.

Implementations§

Source§

impl<'a> LoadContext<'a>

Source

pub fn new(asset_path: AssetPath<'static>) -> Self

Creates a new load context for the given asset path.

Source

pub fn path(&self) -> &AssetPath<'static>

Returns the path of the asset being loaded.

Source

pub fn path_str(&self) -> &str

Returns the asset path as a string.

Source

pub fn extension(&self) -> Option<&str>

Returns the file extension of the asset.

Source

pub fn file_name(&self) -> Option<&str>

Returns the file name of the asset.

Source

pub fn add_dependency(&mut self, dependency_path: impl Into<String>)

Declares that the asset being loaded depends on another asset.

After the load completes, the AssetServer will record this dependency so that changes to dependency_path trigger a cascade reload of the current asset.

§Arguments
  • dependency_path - Path of the asset this asset depends on
Source

pub fn dependencies(&self) -> &[String]

Returns the list of dependencies declared during loading.

Trait Implementations§

Source§

impl<'a> Debug for LoadContext<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for LoadContext<'a>

§

impl<'a> RefUnwindSafe for LoadContext<'a>

§

impl<'a> Send for LoadContext<'a>

§

impl<'a> Sync for LoadContext<'a>

§

impl<'a> Unpin for LoadContext<'a>

§

impl<'a> UnsafeUnpin for LoadContext<'a>

§

impl<'a> UnwindSafe for LoadContext<'a>

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> 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, 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, 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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

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

Source§

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