InstructionContext

Struct InstructionContext 

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

Context provided to instruction hook functions

Implementations§

Source§

impl<'a> InstructionContext<'a>

Source

pub fn new( accounts: HashMap<String, String>, state_id: u32, reverse_lookup_tx: &'a mut dyn ReverseLookupUpdater, ) -> Self

Source

pub fn with_metrics( accounts: HashMap<String, String>, state_id: u32, reverse_lookup_tx: &'a mut dyn ReverseLookupUpdater, registers: &'a mut Vec<RegisterValue>, state_reg: Register, compiled_paths: &'a HashMap<String, CompiledPath>, instruction_data: &'a Value, slot: Option<u64>, signature: Option<String>, timestamp: i64, ) -> Self

Source

pub fn account(&self, name: &str) -> Option<String>

Get an account address by its name from the instruction

Source

pub fn register_pda_reverse_lookup( &mut self, pda_address: &str, seed_value: &str, )

Register a reverse lookup: PDA address -> seed value This also flushes any pending account updates for this PDA

The pending account updates are accumulated internally and can be retrieved via take_pending_updates() after all hooks have executed.

Source

pub fn take_pending_updates(&mut self) -> Vec<PendingAccountUpdate>

Take all accumulated pending updates

This should be called after all instruction hooks have executed to retrieve any pending account updates that need to be reprocessed.

Source

pub fn dirty_tracker(&self) -> &DirtyTracker

Source

pub fn dirty_tracker_mut(&mut self) -> &mut DirtyTracker

Source

pub fn state_value(&self) -> Option<&Value>

Get the current state register value (for generating mutations)

Source

pub fn get<T: DeserializeOwned>(&self, field_path: &str) -> Option<T>

Get a field value from the entity state This allows reading aggregated values or other entity fields

Source

pub fn set<T: Serialize>(&mut self, field_path: &str, value: T)

Source

pub fn increment(&mut self, field_path: &str, amount: i64)

Source

pub fn append<T: Serialize>(&mut self, field_path: &str, value: T)

Source

pub fn data<T: DeserializeOwned>(&self, field: &str) -> Option<T>

Access instruction data field

Source

pub fn timestamp(&self) -> i64

Get the current timestamp

Source

pub fn slot(&self) -> Option<u64>

Get the current slot

Source

pub fn signature(&self) -> Option<&str>

Get the current signature

Auto Trait Implementations§

§

impl<'a> Freeze for InstructionContext<'a>

§

impl<'a> !RefUnwindSafe for InstructionContext<'a>

§

impl<'a> !Send for InstructionContext<'a>

§

impl<'a> !Sync for InstructionContext<'a>

§

impl<'a> Unpin for InstructionContext<'a>

§

impl<'a> !UnwindSafe for InstructionContext<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more