Struct naga::arena::handle::Handle

pub struct Handle<T> {
    index: NonMaxU32,
    marker: PhantomData<T>,
}

A strongly typed reference to an arena item.

A Handle value can be used as an index into an Arena or UniqueArena.

Fields

index: NonMaxU32

marker: PhantomData<T>

Implementations

impl<T> Handle<T>

pub(crate) const fn new(index: NonMaxU32) -> Self

pub const fn index(self) -> usize

Returns the index of this handle.

pub(super) fn from_usize(index: usize) -> Self

Convert a usize index into a Handle<T>.

pub(super) const unsafe fn from_usize_unchecked(index: usize) -> Self

Convert a usize index into a Handle<T>, without range checks.

pub fn write_prefixed( &self, formatter: &mut Formatter<'_>, prefix: &'static str, ) -> Result

Write this handle’s index to formatter, preceded by prefix.

impl Handle<Type>

pub fn to_wgsl(self, gctx: &GlobalCtx<'_>) -> String

Formats the type as it is written in wgsl.

For example vec3<f32>.

impl<T> Handle<T>

fn check_valid_for(self, arena: &Arena<T>) -> Result<(), InvalidHandleError>

Check that self is valid within arena using Arena::check_contains_handle.

fn check_valid_for_uniq( self, arena: &UniqueArena<T>, ) -> Result<(), InvalidHandleError>

where T: Eq + Hash,

Check that self is valid within arena using UniqueArena::check_contains_handle.

fn check_dep(self, depends_on: Self) -> Result<Self, FwdDepError>

Check that depends_on was constructed before self by comparing handle indices.

If self is a valid handle (i.e., it has been validated using Self::check_valid_for) and this function returns Ok, then it may be assumed that depends_on is also valid. In naga’s current arena-based implementation, this is useful for validating recursive definitions of arena-based values in linear time.

Errors

If depends_on’s handle is from the same Arena as self's, but not constructed earlier than self’s, this function returns an error.

fn check_dep_opt(self, depends_on: Option<Self>) -> Result<Self, FwdDepError>

Like Self::check_dep, except for Optional handle values.

fn check_dep_iter( self, depends_on: impl Iterator<Item = Self>, ) -> Result<Self, FwdDepError>

Like Self::check_dep, except for Iterators over handle values.

Trait Implementations

impl<T> Clone for Handle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T> Hash for Handle<T>

fn hash<H: Hasher>(&self, hasher: &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 Index<Handle<Expression>> for CachedExpressions

type Output = u32

The returned type after indexing.

fn index(&self, h: Handle<Expression>) -> &Word

Performs the indexing (container[index]) operation.

impl Index<Handle<Expression>> for ExpressionTypeResolver<'_>

type Output = TypeInner

The returned type after indexing.

fn index(&self, handle: Handle<Expression>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<Expression>> for FunctionInfo

type Output = ExpressionInfo

The returned type after indexing.

fn index(&self, handle: Handle<Expression>) -> &ExpressionInfo

Performs the indexing (container[index]) operation.

impl Index<Handle<Expression>> for ModuleInfo

type Output = TypeResolution

The returned type after indexing.

fn index(&self, handle: Handle<Expression>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<Expression>> for Typifier

type Output = TypeResolution

The returned type after indexing.

fn index(&self, handle: Handle<Expression>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<Function>> for ModuleInfo

type Output = FunctionInfo

The returned type after indexing.

fn index(&self, handle: Handle<Function>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Handle<GlobalVariable>> for FunctionInfo

type Output = GlobalUse

The returned type after indexing.

fn index(&self, handle: Handle<GlobalVariable>) -> &GlobalUse

Performs the indexing (container[index]) operation.

impl<T> Index<Handle<T>> for Arena<T>

type Output = T

The returned type after indexing.

fn index(&self, handle: Handle<T>) -> &T

Performs the indexing (container[index]) operation.

impl<T, U> Index<Handle<T>> for HandleVec<T, U>

type Output = U

The returned type after indexing.

fn index(&self, handle: Handle<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<Handle<T>> for UniqueArena<T>

type Output = T

The returned type after indexing.

fn index(&self, handle: Handle<T>) -> &T

Performs the indexing (container[index]) operation.

impl Index<Handle<Type>> for Layouter

type Output = TypeLayout

The returned type after indexing.

fn index(&self, handle: Handle<Type>) -> &TypeLayout

Performs the indexing (container[index]) operation.

impl Index<Handle<Type>> for ModuleInfo

type Output = TypeFlags

The returned type after indexing.

fn index(&self, handle: Handle<Type>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Handle<Expression>> for CachedExpressions

fn index_mut(&mut self, h: Handle<Expression>) -> &mut Word

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<Handle<T>> for Arena<T>

fn index_mut(&mut self, handle: Handle<T>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T, U> IndexMut<Handle<T>> for HandleVec<T, U>

fn index_mut(&mut self, handle: Handle<T>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> Ord for Handle<T>

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for Handle<T>

fn eq(&self, other: &Self) -> 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<T> PartialOrd for Handle<T>

fn partial_cmp(&self, other: &Self) -> 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<T> Copy for Handle<T>

impl<T> Eq for Handle<T>