Enum move_binary_format::file_format::SignatureToken

pub enum SignatureToken {
    Bool,
    U8,
    U64,
    U128,
    Address,
    Signer,
    Vector(Box<SignatureToken>),
    Struct(StructHandleIndex),
    StructInstantiation(StructHandleIndex, Vec<SignatureToken>),
    Reference(Box<SignatureToken>),
    MutableReference(Box<SignatureToken>),
    TypeParameter(TypeParameterIndex),
}

A SignatureToken is a type declaration for a location.

Any location in the system has a TypeSignature. A TypeSignature is also used in composed signatures.

A SignatureToken can express more types than the VM can handle safely, and correctness is enforced by the verifier.

Variants

Bool

Boolean, true or false.

U8

Unsigned integers, 8 bits length.

U64

Unsigned integers, 64 bits length.

U128

Unsigned integers, 128 bits length.

Address

Address, a 16 bytes immutable type.

Signer

Signer, a 16 bytes immutable type representing the capability to publish at an address

Vector(Box<SignatureToken>)

Vector

Struct(StructHandleIndex)

User defined type

StructInstantiation(StructHandleIndex, Vec<SignatureToken>)

Reference(Box<SignatureToken>)

Reference to a type.

MutableReference(Box<SignatureToken>)

Mutable reference to a type.

TypeParameter(TypeParameterIndex)

Type parameter.

Implementations

impl SignatureToken

pub fn signature_token_kind(&self) -> SignatureTokenKind

Returns the “value kind” for the SignatureToken

pub fn is_integer(&self) -> bool

pub fn is_reference(&self) -> bool

Returns true if the SignatureToken is any kind of reference (mutable and immutable).

pub fn is_mutable_reference(&self) -> bool

Returns true if the SignatureToken is a mutable reference.

pub fn is_signer(&self) -> bool

Returns true if the SignatureToken is a signer

pub fn is_valid_for_constant(&self) -> bool

Returns true if the SignatureToken can represent a constant (as in representable in the constants table).

pub fn debug_set_sh_idx(&mut self, sh_idx: StructHandleIndex)

Set the index to this one. Useful for random testing.

Panics if this token doesn’t contain a struct handle.

pub fn preorder_traversal(&self) -> SignatureTokenPreorderTraversalIter<'_>

pub fn preorder_traversal_with_depth( &self ) -> SignatureTokenPreorderTraversalIterWithDepth<'_>

Trait Implementations

impl Arbitrary for SignatureToken

Arbitrary for SignatureToken cannot be derived automatically as it’s a recursive type.

type Strategy = BoxedStrategy<SignatureToken>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_params: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for SignatureToken

fn clone(&self) -> SignatureToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureToken

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

Formats the value using the given formatter.

impl Hash for SignatureToken

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SignatureToken

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<SignatureToken> for SignatureToken

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

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

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.

impl PartialOrd<SignatureToken> for SignatureToken

fn partial_cmp(&self, other: &SignatureToken) -> 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 SignatureToken

impl StructuralEq for SignatureToken

impl StructuralPartialEq for SignatureToken