Struct ResourceDesc

pub struct ResourceDesc {
    pub dedicated: bool,
    pub data: Or<Box<dyn Any>, NonNull<u8>>,
    /* private fields */
}

A descriptor for registration of a resource.

Normally, resource is owned by an ECS instance, but type-erased raw pointer can also be considered as a resource. In that case, clients must guarantee safety about the pointer. ResourceDesc::with_owned and ResourceDesc::with_ptr are methods about the ownership.

Fields

dedicated: bool

data: Or<Box<dyn Any>, NonNull<u8>>

Implementations

impl ResourceDesc

pub fn new() -> Self

Creates a new empty ResourceDesc.

Examples

use my_ecs::prelude::ResourceDesc;

let desc = ResourceDesc::new();

pub fn with_dedicated(self, is_dedicated: bool) -> Self

Sets whether the resource is dedicated to the descriptor then returns the result.

Dedicated resource is only accessable from main worker for now.

Examples

use my_ecs::prelude::ResourceDesc;

let desc = ResourceDesc::new().with_dedicated(true);

pub fn with_owned<R: Resource>(self, data: R) -> Self

Sets the given owned resource to the descriptor then returns the result.

Examples

use my_ecs::prelude::*;

#[derive(Resource)] struct R(i32);

let desc = ResourceDesc::new().with_owned(R(0));

pub unsafe fn with_ptr<R: Resource>(self, data: *mut R) -> Self

Sets the given pointer as a resource to the descriptor then returns the result.

Safety

After registration the descriptor to an ECS instance, owner of the data must not access the data while the ECS instance is running because the ECS instance may read or write something on the data.

Examples

use my_ecs::prelude::*;

#[derive(Resource)] struct R(i32);

let mut r = R(0);
let desc = unsafe { ResourceDesc::new().with_ptr(&mut r as *mut R) };

Trait Implementations

impl Debug for ResourceDesc

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

Formats the value using the given formatter.

impl Default for ResourceDesc

fn default() -> Self

Returns the “default value” for a type.

impl<R: Resource> From<R> for ResourceDesc

fn from(value: R) -> Self

Converts to this type from the input type.