Struct crayon::utils::handle::Handle

pub struct Handle { /* fields omitted */ }

Handle is made up of two field, index and version. index are usually used to indicated address into some kind of space. This value is recycled when an Handle is freed to save address. However, this means that you could end up with two different Handle with identical indices. We solve this by introducing version.

Methods

impl Handle

fn new(index: HandleIndex, version: HandleIndex) -> Self

Constructs a new Handle.

fn nil() -> Self

Constructs a nil/uninitialized Handle.

fn is_valid(&self) -> bool

Returns true if this Handle has been initialized.

fn invalidate(&mut self)

Invalidate this Handle to default value.

fn index(&self) -> HandleIndex

Returns index value.

fn version(&self) -> HandleIndex

Returns version value.

Trait Implementations

impl Debug for Handle

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Handle

fn default() -> Handle

Returns the "default value" for a type.

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Handle

impl PartialEq for Handle

fn eq(&self, __arg_0: &Handle) -> bool

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

fn ne(&self, __arg_0: &Handle) -> bool

This method tests for !=.

impl Eq for Handle

impl PartialOrd for Handle

fn partial_cmp(&self, __arg_0: &Handle) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Handle) -> bool

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

fn le(&self, __arg_0: &Handle) -> bool

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

fn gt(&self, __arg_0: &Handle) -> bool

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

fn ge(&self, __arg_0: &Handle) -> bool

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

impl Ord for Handle

fn cmp(&self, __arg_0: &Handle) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for Handle

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

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 Deref for Handle

type Target = HandleIndex

The resulting type after dereferencing.

fn deref(&self) -> &HandleIndex

Dereferences the value.

impl Borrow<HandleIndex> for Handle

fn borrow(&self) -> &HandleIndex

Immutably borrows from an owned value.

impl<'a> Borrow<HandleIndex> for &'a Handle

fn borrow(&self) -> &HandleIndex

Immutably borrows from an owned value.

impl From<SurfaceHandle> for Handle

fn from(handle: SurfaceHandle) -> Self

Performs the conversion.

impl From<FrameBufferHandle> for Handle

fn from(handle: FrameBufferHandle) -> Self

Performs the conversion.

impl From<ShaderHandle> for Handle

fn from(handle: ShaderHandle) -> Self

Performs the conversion.

impl From<TextureHandle> for Handle

fn from(handle: TextureHandle) -> Self

Performs the conversion.

impl From<RenderBufferHandle> for Handle

fn from(handle: RenderBufferHandle) -> Self

Performs the conversion.

impl From<IndexBufferHandle> for Handle

fn from(handle: IndexBufferHandle) -> Self

Performs the conversion.

impl From<VertexBufferHandle> for Handle

fn from(handle: VertexBufferHandle) -> Self

Performs the conversion.