Struct naga::arena::handle::Handle

source ·
pub struct Handle<T> {
    index: NonMaxU32,
    marker: PhantomData<T>,
}
Expand description

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§

source§

impl<T> Handle<T>

source

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

source

pub const fn index(self) -> usize

Returns the index of this handle.

source

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

Convert a usize index into a Handle<T>.

source

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

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

source

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

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

source§

impl Handle<Type>

source

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

Formats the type as it is written in wgsl.

For example vec3<f32>.

source§

impl<T> Handle<T>

source

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

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

source

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.

source

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.

source

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

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

source

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§

source§

impl<T> Clone for Handle<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Handle<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, T> Deserialize<'de> for Handle<T>

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> Hash for Handle<T>

source§

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Index<Handle<Expression>> for CachedExpressions

§

type Output = u32

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

§

type Output = TypeInner

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Expression>> for FunctionInfo

§

type Output = ExpressionInfo

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Expression>> for ModuleInfo

§

type Output = TypeResolution

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Expression>> for Typifier

§

type Output = TypeResolution

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Function>> for ModuleInfo

§

type Output = FunctionInfo

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<GlobalVariable>> for FunctionInfo

§

type Output = GlobalUse

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

§

type Output = T

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

§

type Output = U

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

§

type Output = T

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Type>> for Layouter

§

type Output = TypeLayout

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<Handle<Type>> for ModuleInfo

§

type Output = TypeFlags

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<Handle<Expression>> for CachedExpressions

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

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

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

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

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<T> Ord for Handle<T>

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<T> PartialEq for Handle<T>

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T> PartialOrd for Handle<T>

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<T> Serialize for Handle<T>

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<T> Copy for Handle<T>

source§

impl<T> Eq for Handle<T>

Auto Trait Implementations§

§

impl<T> Freeze for Handle<T>

§

impl<T> RefUnwindSafe for Handle<T>
where T: RefUnwindSafe,

§

impl<T> Send for Handle<T>
where T: Send,

§

impl<T> Sync for Handle<T>
where T: Sync,

§

impl<T> Unpin for Handle<T>
where T: Unpin,

§

impl<T> UnwindSafe for Handle<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,