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),
}
Expand description

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§

source§

impl SignatureToken

source

pub fn signature_token_kind(&self) -> SignatureTokenKind

Returns the “value kind” for the SignatureToken

source

pub fn is_integer(&self) -> bool

source

pub fn is_reference(&self) -> bool

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

source

pub fn is_mutable_reference(&self) -> bool

Returns true if the SignatureToken is a mutable reference.

source

pub fn is_signer(&self) -> bool

Returns true if the SignatureToken is a signer

source

pub fn is_valid_for_constant(&self) -> bool

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

source

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.

source

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

source

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

Trait Implementations§

source§

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

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. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
source§

impl Clone for SignatureToken

source§

fn clone(&self) -> SignatureToken

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 Debug for SignatureToken

source§

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

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

impl Hash for SignatureToken

source§

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

source§

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

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

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

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

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

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

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

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

impl PartialEq<SignatureToken> for SignatureToken

source§

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

source§

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

source§

impl StructuralEq for SignatureToken

source§

impl StructuralPartialEq for SignatureToken

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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 Twhere 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V