Struct solana_libra_vm::file_format::StructHandle

pub struct StructHandle {
    pub module: ModuleHandleIndex,
    pub name: IdentifierIndex,
    pub is_nominal_resource: bool,
    pub type_formals: Vec<Kind>,
}

A StructHandle is a reference to a user defined type. It is composed by a ModuleHandle and the name of the type within that module.

A type in a module is uniquely identified by its name and as such the name is enough to perform resolution.

The StructHandle is polymorphic: it can have type parameters in its fields and carries the kind constraints for these type parameters (empty list for non-generic structs). It also carries the kind (resource/copyable) of the struct itself so that the verifier can check resource semantic without having to load the referenced type.

At link time kind checking is performed and an error is reported if there is a mismatch with the definition.

Fields

module: ModuleHandleIndex

The module that defines the type.

name: IdentifierIndex

The name of the type.

is_nominal_resource: bool

There are two ways for a type to have the Kind resource

1. If it has a type argument of resource
2. If it was declared as a resource These "declared" resources are referred to as nominal resources

If is_nominal_resource is true, it is a nominal resource

type_formals: Vec<Kind>

The type formals (identified by their index into the vec) and their kind constraints

Trait Implementations

impl<'_> BoundsCheck<&'_ CompiledModuleMut> for StructHandle

fn check_bounds(&self, module: &CompiledModuleMut) -> Vec<VMStatus>

impl Clone for StructHandle

fn clone(&self) -> StructHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructHandle

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

Formats the value using the given formatter.

impl Eq for StructHandle

impl Hash for StructHandle

fn hash<__H: Hasher>(&self, state: &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 Ord for StructHandle

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<StructHandle> for StructHandle

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

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

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

This method tests for !=.

impl PartialOrd<StructHandle> for StructHandle

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for StructHandle

impl StructuralPartialEq for StructHandle