Struct InstructionContext 

pub struct InstructionContext<'a> { /* private fields */ }

View interface to read instructions.

Implementations

impl<'a> InstructionContext<'a>

pub fn get_stack_height(&self) -> usize

How many Instructions were on the stack after this one was pushed

That is the number of nested parent Instructions plus one (itself).

pub fn get_number_of_instruction_accounts(&self) -> IndexOfAccount

Number of accounts in this Instruction (without program accounts)

pub fn check_number_of_instruction_accounts( &self, expected_at_least: IndexOfAccount, ) -> Result<(), InstructionError>

Assert that enough accounts were supplied to this Instruction

pub fn get_instruction_data(&self) -> &[u8]

Data parameter for the programs process_instruction handler

pub fn find_index_of_instruction_account( &self, transaction_context: &TransactionContext, pubkey: &Pubkey, ) -> Option<IndexOfAccount>

Searches for an instruction account by its key

pub fn get_index_of_program_account_in_transaction( &self, ) -> Result<IndexOfAccount, InstructionError>

Translates the given instruction wide program_account_index into a transaction wide index

pub fn get_index_of_instruction_account_in_transaction( &self, instruction_account_index: IndexOfAccount, ) -> Result<IndexOfAccount, InstructionError>

Translates the given instruction wide instruction_account_index into a transaction wide index

pub fn get_index_of_account_in_instruction( &self, index_in_transaction: IndexOfAccount, ) -> Result<IndexOfAccount, InstructionError>

Get the index of account in instruction from the index in transaction

pub fn is_instruction_account_duplicate( &self, instruction_account_index: IndexOfAccount, ) -> Result<Option<IndexOfAccount>, InstructionError>

Returns Some(instruction_account_index) if this is a duplicate and None if it is the first account with this key

pub fn get_program_key(&self) -> Result<&'a Pubkey, InstructionError>

Gets the key of the last program account of this Instruction

pub fn get_program_owner(&self) -> Result<Pubkey, InstructionError>

Get the owner of the program account of this instruction

pub fn try_borrow_instruction_account( &self, index_in_instruction: IndexOfAccount, ) -> Result<BorrowedAccount<'_>, InstructionError>

Gets an instruction account of this Instruction

pub fn is_instruction_account_signer( &self, instruction_account_index: IndexOfAccount, ) -> Result<bool, InstructionError>

Returns whether an instruction account is a signer

pub fn is_instruction_account_writable( &self, instruction_account_index: IndexOfAccount, ) -> Result<bool, InstructionError>

Returns whether an instruction account is writable

pub fn get_signers(&self) -> Result<HashSet<Pubkey>, InstructionError>

Calculates the set of all keys of signer instruction accounts in this Instruction

pub fn instruction_accounts(&self) -> &[InstructionAccount]

pub fn get_key_of_instruction_account( &self, index_in_instruction: IndexOfAccount, ) -> Result<&'a Pubkey, InstructionError>

Trait Implementations

impl<'a> Clone for InstructionContext<'a>

fn clone(&self) -> InstructionContext<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InstructionContext<'a>

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

Formats the value using the given formatter.