Struct ResourceIndex

pub struct ResourceIndex(/* private fields */);

A unique resource identifier.

Resource index is composed of index(usize) and generation(u64). The generation is determined when the resource is registered to an ECS instance. The generation help us detect stale resource identifiers.

Implementations

impl ResourceIndex

pub const fn new(index: usize, generation: u64) -> Self

Creates a new ResourceIndex with the given index and generation.

pub const fn dummy() -> Self

Creates a dummy ResourceIndex.

pub fn is_dummy(&self) -> bool

Returns true if the resource index is dummy.

pub fn index(&self) -> usize

Returns inner index.

pub fn generation(&self) -> u64

Returns inner generation.

Trait Implementations

impl Clone for ResourceIndex

fn clone(&self) -> ResourceIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceIndex

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

Formats the value using the given formatter.

impl Default for ResourceIndex

fn default() -> Self

Returns the “default value” for a type.

impl Display for ResourceIndex

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

Formats the value using the given formatter.

impl Hash for ResourceIndex

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ResourceIndex

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ResourceIndex

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ResourceIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ResourceIndex

impl Eq for ResourceIndex

impl StructuralPartialEq for ResourceIndex