Struct ShortIndex

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

An optional index used within the model system, that is up to 65000

It can be, effectively, ‘None’ or Some(usize less than 65000)

The purpose is to keep the size of indexed structures small and permit the optional aspect; it is used to index Vec of textures, vertices descriptor sets, etc

It has implementations of From<> to map a usize into a ShortIndex, and to map from ShortIndex to Option; plus to map from Option (or anything that is Into) to a ShortIndex, to ease use.

These extra implementations remove some of the type safety one might have, but make it simpler to use the index

Implementations

impl ShortIndex

pub fn none() -> Self

cp none Create a ‘None’ value

pub fn as_usize(self) -> usize

ap as_usize Return the value - if it is effectively None, then panic

pub fn is_none(self) -> bool

ap is_none Return true if the index is None

pub fn is_some(self) -> bool

ap is_some Return true if the index is not None

Trait Implementations

impl Clone for ShortIndex

fn clone(&self) -> ShortIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShortIndex

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

Formats the value using the given formatter.

impl Default for ShortIndex

fn default() -> Self

Returns the “default value” for a type.

impl<I: Into<usize>> From<Option<I>> for ShortIndex

fn from(opt_index: Option<I>) -> Self

Converts to this type from the input type.

impl From<ShortIndex> for Option<usize>

fn from(index: ShortIndex) -> Option<usize>

Converts to this type from the input type.

impl From<usize> for ShortIndex

fn from(index: usize) -> Self

Converts to this type from the input type.

impl PartialEq for ShortIndex

fn eq(&self, other: &ShortIndex) -> 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 Copy for ShortIndex

impl Eq for ShortIndex

impl StructuralPartialEq for ShortIndex