Struct specs::prelude::ResourceId

pub struct ResourceId { /* fields omitted */ }

The id of a Resource, which simply wraps a type id and a "dynamic ID". The "dynamic ID" is usually just left 0, and, unless such documentation says otherwise, other libraries will assume that it is always 0; non-zero IDs are only used for special resource types that are specifically defined in a more dynamic way, such that resource types can essentially be created at run time, without having different static types.

Methods

impl ResourceId

pub fn new<T>() -> ResourceId where
    T: Resource, 

Creates a new resource id from a given type.

pub fn from_type_id(type_id: TypeId) -> ResourceId

Create a new resource id from a raw type ID.

pub fn new_with_dynamic_id<T>(dynamic_id: u64) -> ResourceId where
    T: Resource, 

Creates a new resource id from a given type and a dynamic_id.

This is usually not what you want (unless you're implementing scripting with shred or some similar mechanism to define resources at run-time).

Creating resource IDs with a dynamic_id unequal to 0 is only recommended for special types that are specifically defined for scripting; most libraries will just assume that resources are identified only by their type.

pub fn from_type_id_and_dynamic_id(
    type_id: TypeId,
    dynamic_id: u64
) -> ResourceId

Create a new resource id from a raw type ID and a "dynamic ID" (see type documentation).

Trait Implementations

impl Clone for ResourceId

fn clone(&self) -> ResourceId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceId

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

Formats the value using the given formatter.

impl Eq for ResourceId

impl Hash for ResourceId

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for ResourceId

fn cmp(&self, other: &ResourceId) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ResourceId> for ResourceId

fn eq(&self, other: &ResourceId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ResourceId) -> bool

This method tests for !=.

impl PartialOrd<ResourceId> for ResourceId

fn partial_cmp(&self, other: &ResourceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ResourceId) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ResourceId) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ResourceId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ResourceId) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ResourceId

impl StructuralPartialEq for ResourceId