Struct move_binary_format::file_format::StructHandle

pub struct StructHandle {
    pub module: ModuleHandleIndex,
    pub name: IdentifierIndex,
    pub abilities: AbilitySet,
    pub type_parameters: Vec<StructTypeParameter>,
}

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 ability constraints for these type parameters (empty list for non-generic structs). It also carries the abilities of the struct itself so that the verifier can check ability semantics without having to load the referenced type.

At link time ability/constraint 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.

abilities: AbilitySet

Contains the abilities for this struct For any instantiation of this type, the abilities of this type are predicated on that ability being satisfied for all type parameters.

type_parameters: Vec<StructTypeParameter>

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

Implementations

impl StructHandle

pub fn type_param_constraints(
    &self
) -> impl ExactSizeIterator<Item = AbilitySet> + '_

Trait Implementations

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 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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl Eq for StructHandle

impl StructuralEq for StructHandle

impl StructuralPartialEq for StructHandle