Struct specs::prelude::ResourceId
source · pub struct ResourceId { /* private fields */ }
Expand description
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.
Implementations§
source§impl ResourceId
impl ResourceId
sourcepub fn new<T>() -> ResourceIdwhere
T: Resource,
pub fn new<T>() -> ResourceIdwhere T: Resource,
Creates a new resource id from a given type.
sourcepub fn from_type_id(type_id: TypeId) -> ResourceId
pub fn from_type_id(type_id: TypeId) -> ResourceId
Create a new resource id from a raw type ID.
sourcepub fn new_with_dynamic_id<T>(dynamic_id: u64) -> ResourceIdwhere
T: Resource,
pub fn new_with_dynamic_id<T>(dynamic_id: u64) -> ResourceIdwhere 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.
sourcepub fn from_type_id_and_dynamic_id(
type_id: TypeId,
dynamic_id: u64
) -> ResourceId
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§
source§impl Clone for ResourceId
impl Clone for ResourceId
source§fn clone(&self) -> ResourceId
fn clone(&self) -> ResourceId
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ResourceId
impl Debug for ResourceId
source§impl Hash for ResourceId
impl Hash for ResourceId
source§impl Ord for ResourceId
impl Ord for ResourceId
source§fn cmp(&self, other: &ResourceId) -> Ordering
fn cmp(&self, other: &ResourceId) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ResourceId> for ResourceId
impl PartialEq<ResourceId> for ResourceId
source§fn eq(&self, other: &ResourceId) -> bool
fn eq(&self, other: &ResourceId) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ResourceId> for ResourceId
impl PartialOrd<ResourceId> for ResourceId
source§fn partial_cmp(&self, other: &ResourceId) -> Option<Ordering>
fn partial_cmp(&self, other: &ResourceId) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more