Struct genmap::Handle

pub struct Handle { /* fields omitted */ }

A small, easy-to-copy handle referring to a location in a particular GenMap.

Handles from one GenMap are not valid to use in a different GenMap, and this can not be detected at runtime. It is recommended to wrap handles in a newtype struct to make sure at compile-time that you have the right one. Support for this may become built in to the API, but for the moment it's unclear how to do it best.

Trait Implementations

impl Clone for Handle

pub fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Handle

impl Debug for Handle

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

Formats the value using the given formatter.

impl Eq for Handle

impl Hash for Handle

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

Feeds this value into the given Hasher.

pub 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 Handle

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Handle> for Handle

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

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

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

This method tests for !=.

impl PartialOrd<Handle> for Handle

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Handle

impl StructuralPartialEq for Handle