Struct BorrowedAccount

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

Shared account borrowed from the TransactionContext and an InstructionContext.

Implementations

impl<'a> BorrowedAccount<'a>

pub fn transaction_context(&self) -> &TransactionContext

Returns the transaction context

pub fn get_index_in_transaction(&self) -> IndexOfAccount

Returns the index of this account (transaction wide)

pub fn get_key(&self) -> &Pubkey

Returns the public key of this account (transaction wide)

pub fn get_owner(&self) -> &Pubkey

Returns the owner of this account (transaction wide)

pub fn set_owner(&mut self, pubkey: &[u8]) -> Result<(), InstructionError>

Assignes the owner of this account (transaction wide)

pub fn get_lamports(&self) -> u64

Returns the number of lamports of this account (transaction wide)

pub fn set_lamports(&mut self, lamports: u64) -> Result<(), InstructionError>

Overwrites the number of lamports of this account (transaction wide)

pub fn checked_add_lamports( &mut self, lamports: u64, ) -> Result<(), InstructionError>

Adds lamports to this account (transaction wide)

pub fn checked_sub_lamports( &mut self, lamports: u64, ) -> Result<(), InstructionError>

Subtracts lamports from this account (transaction wide)

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

Returns a read-only slice of the account data (transaction wide)

pub fn get_data_mut(&mut self) -> Result<&mut [u8], InstructionError>

Returns a writable slice of the account data (transaction wide)

pub fn spare_data_capacity_mut( &mut self, ) -> Result<&mut [MaybeUninit<u8>], InstructionError>

Returns the spare capacity of the vector backing the account data.

This method should only ever be used during CPI, where after a shrinking realloc we want to zero the spare capacity.

pub fn set_data_from_slice( &mut self, data: &[u8], ) -> Result<(), InstructionError>

Overwrites the account data and size (transaction wide).

Call this when you have a slice of data you do not own and want to replace the account data with it.

pub fn set_data_length( &mut self, new_length: usize, ) -> Result<(), InstructionError>

Resizes the account data (transaction wide)

Fills it with zeros at the end if is extended or truncates at the end otherwise.

pub fn extend_from_slice(&mut self, data: &[u8]) -> Result<(), InstructionError>

Appends all elements in a slice to the account

pub fn reserve(&mut self, additional: usize) -> Result<(), InstructionError>

Reserves capacity for at least additional more elements to be inserted in the given account. Does nothing if capacity is already sufficient.

pub fn capacity(&self) -> usize

Returns the number of bytes the account can hold without reallocating.

pub fn is_shared(&self) -> bool

Returns whether the underlying AccountSharedData is shared.

The data is shared if the account has been loaded from the accounts database and has never been written to. Writing to an account unshares it.

During account serialization, if an account is shared it’ll get mapped as CoW, else it’ll get mapped directly as writable.

pub fn get_state<T: DeserializeOwned>(&self) -> Result<T, InstructionError>

Deserializes the account data into a state

pub fn set_state<T: Serialize>( &mut self, state: &T, ) -> Result<(), InstructionError>

Serializes a state into the account data

pub fn is_rent_exempt_at_data_length(&self, data_length: usize) -> bool

pub fn is_executable(&self) -> bool

Returns whether this account is executable (transaction wide)

pub fn set_executable( &mut self, is_executable: bool, ) -> Result<(), InstructionError>

Configures whether this account is executable (transaction wide)

pub fn get_rent_epoch(&self) -> u64

Returns the rent epoch of this account (transaction wide)

pub fn is_signer(&self) -> bool

Returns whether this account is a signer (instruction wide)

pub fn is_writable(&self) -> bool

Returns whether this account is writable (instruction wide)

pub fn is_owned_by_current_program(&self) -> bool

Returns true if the owner of this account is the current InstructionContexts last program (instruction wide)

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

Returns an error if the account data can not be mutated by the current program

pub fn can_data_be_resized( &self, new_length: usize, ) -> Result<(), InstructionError>

Returns an error if the account data can not be resized to the given length

Trait Implementations

impl<'a> Debug for BorrowedAccount<'a>

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

Formats the value using the given formatter.