Struct bones_lib::ecs::prelude::AtomicResource

source ·
pub struct AtomicResource<T>
where T: HasSchema,
{ /* private fields */ }
Expand description

A handle to a resource from a Resources collection.

This is not the resource itself, but a cheaply clonable handle to it.

To access the resource you must borrow it with either borrow() or borrow_mut().

Implementations§

source§

impl<T> AtomicResource<T>
where T: HasSchema,

source

pub fn empty() -> AtomicResource<T>

Create a new, empty resource cell.

source

pub fn new(data: T) -> AtomicResource<T>

Create a new resource cell with the given data.

source

pub fn from_untyped( untyped: Arc<UntypedResource>, ) -> Result<AtomicResource<T>, SchemaMismatchError>

Create from an UntypedResource.

source

pub fn remove(&self) -> Option<T>

Remove the resource from the cell, leaving the cell empty.

source

pub fn borrow(&self) -> Option<Ref<'_, T>>

Lock the resource for reading.

This returns a read guard, very similar to an RwLock.

source

pub fn borrow_mut(&self) -> Option<RefMut<'_, T>>

Lock the resource for read-writing.

This returns a write guard, very similar to an RwLock.

source

pub fn into_untyped(self) -> Arc<UntypedResource>

Convert into an untyped resource.

source§

impl<T> AtomicResource<T>
where T: HasSchema + FromWorld,

source

pub fn init(&self, world: &World)

Initialize the resource using it’s FromWorld implementation, if it is not present.

source

pub fn init_borrow(&self, world: &World) -> Ref<'_, T>

Borrow the resource, initializing it if it doesn’t exist.

source

pub fn init_borrow_mut(&self, world: &World) -> RefMut<'_, T>

Borrow the resource, initializing it if it doesn’t exist.

Trait Implementations§

source§

impl<T> Clone for AtomicResource<T>
where T: Clone + HasSchema,

source§

fn clone(&self) -> AtomicResource<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for AtomicResource<T>
where T: HasSchema + Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Default for AtomicResource<T>
where T: HasSchema + Default,

source§

fn default() -> AtomicResource<T>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for AtomicResource<T>

§

impl<T> !RefUnwindSafe for AtomicResource<T>

§

impl<T> Send for AtomicResource<T>

§

impl<T> Sync for AtomicResource<T>

§

impl<T> Unpin for AtomicResource<T>
where T: Unpin,

§

impl<T> !UnwindSafe for AtomicResource<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<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &World) -> T

Creates Self using data from the given World.
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> RawClone for T
where T: Clone,

source§

unsafe fn raw_clone(src: *const c_void, dst: *mut c_void)

Write the default value of the type to the pointer. Read more
source§

fn raw_clone_cb() -> Unsafe<&'static (dyn Fn(*const c_void, *mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T> RawDefault for T
where T: Default,

source§

unsafe fn raw_default(dst: *mut c_void)

Write the default value of the type to the pointer. Read more
source§

fn raw_default_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T> RawDrop for T

source§

unsafe fn raw_drop(ptr: *mut c_void)

Write the default value of the type to the pointer. Read more
source§

fn raw_drop_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T> ToOwned for T
where T: Clone,

§

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

§

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V