Struct solana_sdk::transaction_context::TransactionContext

source · [−]

pub struct TransactionContext { /* private fields */ }

Expand description

Loaded transaction shared between runtime and programs.

This context is valid for the entire duration of a transaction being processed.

Implementations

source

impl TransactionContext

source

pub fn new(
 transaction_accounts: Vec<TransactionAccount>,
 instruction_context_capacity: usize,
 number_of_instructions_at_transaction_level: usize
) -> Self

Constructs a new TransactionContext

source

pub fn deconstruct(
self
) -> (Vec<TransactionAccount>, Vec<Vec<InstructionContext>>)

Used by the bank in the runtime to write back the processed accounts and recorded instructions

source

pub fn deconstruct_without_keys(
self
) -> Result<Vec<AccountSharedData>, InstructionError>

Used in mock_process_instruction

source

pub fn get_number_of_accounts(&self) -> usize

Returns the total number of accounts loaded in this Transaction

source

pub fn get_key_of_account_at_index(
&self,
index_in_transaction: usize
) -> Result<&Pubkey, InstructionError>

Searches for an account by its key

source

pub fn get_keys_of_accounts(&self) -> &[Pubkey ]

Returns the keys for the accounts loaded in this Transaction

source

pub fn get_account_at_index(
&self,
index_in_transaction: usize
) -> Result<&RefCell<AccountSharedData>, InstructionError>

Searches for an account by its key

source

pub fn find_index_of_account(&self, pubkey: &Pubkey) -> Option<usize>

Searches for an account by its key

source

pub fn find_index_of_program_account(&self, pubkey: &Pubkey) -> Option<usize>

Searches for a program account by its key

source

pub fn get_instruction_context_at(
&self,
level: usize
) -> Result<&InstructionContext, InstructionError>

Gets an InstructionContext by its nesting level in the stack

source

pub fn get_instruction_context_capacity(&self) -> usize

Gets the max height of the InstructionContext stack

source

pub fn get_instruction_context_stack_height(&self) -> usize

Gets instruction stack height, top-level instructions are height solana_sdk::instruction::TRANSACTION_LEVEL_STACK_HEIGHT

source

pub fn get_current_instruction_context(
&self
) -> Result<&InstructionContext, InstructionError>

Returns the current InstructionContext

source

pub fn push(
 &mut self,
 program_accounts: &[usize ],
 instruction_accounts: &[InstructionAccount ],
 instruction_data: &[u8 ],
 record_instruction_in_transaction_context_push: bool
) -> Result<(), InstructionError>

Pushes a new InstructionContext

source

pub fn pop(&mut self) -> Result<(), InstructionError>

Pops the current InstructionContext

source

pub fn get_return_data(&self) -> (&Pubkey, &[u8 ])

Gets the return data of the current InstructionContext or any above

source

pub fn set_return_data(
 &mut self,
 program_id: Pubkey,
 data: Vec<u8>
) -> Result<(), InstructionError>

Set the return data of the current InstructionContext

source

pub fn record_instruction(&mut self, instruction: InstructionContext)

Used by the runtime when a new CPI instruction begins

Deprecated, automatically done in push() once record_instruction_in_transaction_context_push is activated.

source

pub fn get_instruction_trace(&self) -> &InstructionTrace

Returns instruction trace

Trait Implementations

source

impl Debug for TransactionContext

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for TransactionContext

impl Send for TransactionContext

impl !Sync for TransactionContext

impl Unpin for TransactionContext

impl UnwindSafe for TransactionContext

Blanket Implementations

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
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 for T where
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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct solana_sdk::transaction_context::TransactionContext

Implementations

impl TransactionContext

pub fn new( transaction_accounts: Vec<TransactionAccount>, instruction_context_capacity: usize, number_of_instructions_at_transaction_level: usize) -> Self

pub fn deconstruct( self) -> (Vec<TransactionAccount>, Vec<Vec<InstructionContext>>)

pub fn deconstruct_without_keys( self) -> Result<Vec<AccountSharedData>, InstructionError>

pub fn get_number_of_accounts(&self) -> usize

pub fn get_key_of_account_at_index( &self, index_in_transaction: usize) -> Result<&Pubkey, InstructionError>

pub fn get_keys_of_accounts(&self) -> &[Pubkey]

pub fn get_account_at_index( &self, index_in_transaction: usize) -> Result<&RefCell<AccountSharedData>, InstructionError>

pub fn find_index_of_account(&self, pubkey: &Pubkey) -> Option<usize>

pub fn find_index_of_program_account(&self, pubkey: &Pubkey) -> Option<usize>

pub fn get_instruction_context_at( &self, level: usize) -> Result<&InstructionContext, InstructionError>

pub fn get_instruction_context_capacity(&self) -> usize

pub fn get_instruction_context_stack_height(&self) -> usize

pub fn get_current_instruction_context( &self) -> Result<&InstructionContext, InstructionError>

pub fn push( &mut self, program_accounts: &[usize], instruction_accounts: &[InstructionAccount], instruction_data: &[u8], record_instruction_in_transaction_context_push: bool) -> Result<(), InstructionError>

pub fn pop(&mut self) -> Result<(), InstructionError>

pub fn get_return_data(&self) -> (&Pubkey, &[u8])

pub fn set_return_data( &mut self, program_id: Pubkey, data: Vec<u8>) -> Result<(), InstructionError>

pub fn record_instruction(&mut self, instruction: InstructionContext)

pub fn get_instruction_trace(&self) -> &InstructionTrace

Trait Implementations

impl Debug for TransactionContext

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

Auto Trait Implementations

impl !RefUnwindSafe for TransactionContext

impl Send for TransactionContext

impl !Sync for TransactionContext

impl Unpin for TransactionContext

impl UnwindSafe for TransactionContext

Blanket Implementations

impl<T> AbiExample for T

default fn example() -> T

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

pub fn new(
transaction_accounts: Vec<TransactionAccount>,
instruction_context_capacity: usize,
number_of_instructions_at_transaction_level: usize
) -> Self

pub fn deconstruct(
self
) -> (Vec<TransactionAccount>, Vec<Vec<InstructionContext>>)

pub fn deconstruct_without_keys(
self
) -> Result<Vec<AccountSharedData>, InstructionError>

pub fn get_key_of_account_at_index(
&self,
index_in_transaction: usize
) -> Result<&Pubkey, InstructionError>

pub fn get_keys_of_accounts(&self) -> &[Pubkey ]

pub fn get_account_at_index(
&self,
index_in_transaction: usize
) -> Result<&RefCell<AccountSharedData>, InstructionError>

pub fn get_instruction_context_at(
&self,
level: usize
) -> Result<&InstructionContext, InstructionError>

pub fn get_current_instruction_context(
&self
) -> Result<&InstructionContext, InstructionError>

pub fn push(
&mut self,
program_accounts: &[usize ],
instruction_accounts: &[InstructionAccount ],
instruction_data: &[u8 ],
record_instruction_in_transaction_context_push: bool
) -> Result<(), InstructionError>

pub fn get_return_data(&self) -> (&Pubkey, &[u8 ])

pub fn set_return_data(
&mut self,
program_id: Pubkey,
data: Vec<u8>
) -> Result<(), InstructionError>

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

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

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

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

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

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