Struct Environment

pub struct Environment { /* private fields */ }

Information about the execution environment.

Implementations

impl Environment

pub fn mode(&self) -> Mode

Execution mode.

pub fn is_check_only(&self) -> bool

Whether the execution mode is such that only checks should be performed.

pub fn is_pre_schedule(&self) -> bool

Whether the execution mode is Mode::PreSchedule.

pub fn is_simulation(&self) -> bool

Whether the execution mode is Mode::Simulate.

pub fn is_execute(&self) -> bool

Whether the execution mode is Mode::Execute.

pub fn is_transaction(&self) -> bool

Whether there is an active transaction in the current environment.

pub fn tx_index(&self) -> usize

An active transaction’s index (order) within the block.

Panics

This method will panic if called outside a transaction environment.

pub fn tx_size(&self) -> u32

An active transaction’s size in bytes.

Panics

This method will panic if called outside a transaction environment.

pub fn tx_auth_info(&self) -> &AuthInfo

An active transaction’s authentication information.

Panics

This method will panic if called outside a transaction environment.

pub fn tx_call_format(&self) -> CallFormat

An active transaction’s call format.

Panics

This method will panic if called outside a transaction environment.

pub fn is_read_only(&self) -> bool

An active transaction’s read only flag.

Panics

This method will panic if called outside a transaction environment.

pub fn is_internal(&self) -> bool

Whether the current execution environment is part of an internal subcall.

pub fn tx_caller_address(&self) -> Address

Authenticated address of the caller.

In case there are multiple signers of a transaction, this will return the address corresponding to the first signer. If there are no signers, it returns the default address.

Panics

This method will panic if called outside a transaction environment.

pub fn tx_caller_public_key(&self) -> Option<PublicKey>

Authenticated caller public key if available.

In case there are multiple signers of a transaction, this will return the public key corresponding to the first signer. If there are no signers or if the address specification does not represent a single public key, it returns None.

Panics

This method will panic if called outside a transaction environment.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Environment

Returns the “default value” for a type.