Skip to main content

Handle

Struct Handle 

Source
pub struct Handle<A: Asset + ?Sized> { /* private fields */ }
Expand description

Resource read-only handle

Implementations§

Source§

impl<A: Asset> Handle<A>

Source

pub fn id(&self) -> AssetId<A>

Get AssetId of this handle

Source

pub fn read(&self) -> AssetRead<'_, A>

Get a reading lock from the asset

Examples found in repository?
examples/assets.rs (line 39)
30fn main() {
31    let mut asset_server = AssetServer::with_root("assets");
32    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
33    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
34    asset_server.load::<Texture>("example.png").unwrap();
35    asset_server.load::<Audio>("music.ogg").unwrap();
36    println!("{asset_server:#?}");
37
38    let audio = asset_server.get_named::<Audio>("music").unwrap();
39    println!("{:?}", audio.read().0);
40    audio.write().0 = 1.0;
41    println!("{:?}", audio.read().0);
42}
Source

pub fn write(&self) -> AssetWrite<'_, A>

Get a writing lock into the asset

Examples found in repository?
examples/assets.rs (line 40)
30fn main() {
31    let mut asset_server = AssetServer::with_root("assets");
32    asset_server.register_loader::<Texture>(Box::new(TextureLoader));
33    asset_server.register_loader::<Audio>(Box::new(AudioLoader));
34    asset_server.load::<Texture>("example.png").unwrap();
35    asset_server.load::<Audio>("music.ogg").unwrap();
36    println!("{asset_server:#?}");
37
38    let audio = asset_server.get_named::<Audio>("music").unwrap();
39    println!("{:?}", audio.read().0);
40    audio.write().0 = 1.0;
41    println!("{:?}", audio.read().0);
42}

Trait Implementations§

Source§

impl<A: Clone + Asset + ?Sized> Clone for Handle<A>

Source§

fn clone(&self) -> Handle<A>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<A: Asset + ?Sized> Component for Handle<A>

Source§

type Storage = VecStorage<Handle<A>>

Associated storage type for this component.
Source§

impl<A: Debug + Asset + ?Sized> Debug for Handle<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 Handle<A>
where A: ?Sized,

§

impl<A> RefUnwindSafe for Handle<A>
where A: ?Sized,

§

impl<A> Send for Handle<A>
where A: ?Sized,

§

impl<A> Sync for Handle<A>
where A: ?Sized,

§

impl<A> Unpin for Handle<A>
where A: ?Sized,

§

impl<A> UnsafeUnpin for Handle<A>
where A: ?Sized,

§

impl<A> UnwindSafe for Handle<A>
where A: ?Sized,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> Asset for T
where T: Any + Send + Sync + 'static + Debug,

Source§

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

Source§

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