Struct AccountInfo

#[repr(C)]
pub struct AccountInfo { /* private fields */ }

Wrapper struct for an Account.

This struct provides safe access to the data in an Account. It is also used to track borrows of the account data and lamports, given that an account can be “shared” across multiple AccountInfo instances.

Implementations

impl AccountInfo

pub fn key(&self) -> &Pubkey

Public key of the account.

pub fn owner(&self) -> &Pubkey

Program that owns this account.

pub fn is_signer(&self) -> bool

Indicates whether the transaction was signed by this account.

pub fn is_writable(&self) -> bool

Indicates whether the account is writable.

pub fn executable(&self) -> bool

Indicates whether this account represents a program.

Program accounts are always read-only.

pub fn data_len(&self) -> usize

Returns the size of the data in the account.

pub fn data_is_empty(&self) -> bool

Indicates whether the account data is empty.

An account is considered empty if the data length is zero.

pub fn assign(&self, new_owner: &Pubkey)

Changes the owner of the account.

pub unsafe fn unchecked_borrow_lamports(&self) -> &u64

Returns a read-only reference to the lamports in the account.

SAFETY

This does not check or modify the 4-bit refcell. Useful when instruction has verified non-duplicate accounts.

pub unsafe fn unchecked_borrow_mut_lamports(&self) -> &mut u64

Returns a mutable reference to the lamports in the account.

SAFETY

This does not check or modify the 4-bit refcell. Useful when instruction has verified non-duplicate accounts.

pub unsafe fn unchecked_borrow_data(&self) -> &[u8]

Returns a read-only reference to the data in the account.

SAFETY

This does not check or modify the 4-bit refcell. Useful when instruction has verified non-duplicate accounts.

pub unsafe fn unchecked_borrow_mut_data(&self) -> &mut [u8]

Returns a mutable reference to the data in the account.

SAFETY

This does not check or modify the 4-bit refcell. Useful when instruction has verified non-duplicate accounts.

pub fn try_borrow_lamports(&self) -> Result<Ref<'_, u64>, ProgramError>

Tries to get a read-only reference to the lamport field, failing if the field is already mutable borrowed or if 7 borrows already exist.

pub fn try_borrow_mut_lamports(&self) -> Result<RefMut<'_, u64>, ProgramError>

Tries to get a read only reference to the lamport field, failing if the field is already borrowed in any form.

pub fn try_borrow_data(&self) -> Result<Ref<'_, [u8]>, ProgramError>

Tries to get a read only reference to the data field, failing if the field is already mutable borrowed or if 7 borrows already exist.

pub fn try_borrow_mut_data(&self) -> Result<RefMut<'_, [u8]>, ProgramError>

Tries to get a read only reference to the data field, failing if the field is already borrowed in any form.

pub fn realloc( &self, new_len: usize, zero_init: bool, ) -> Result<(), ProgramError>

Realloc the account’s data and optionally zero-initialize the new memory.

Note: Account data can be increased within a single call by up to solana_program::entrypoint::MAX_PERMITTED_DATA_INCREASE bytes.

Note: Memory used to grow is already zero-initialized upon program entrypoint and re-zeroing it wastes compute units. If within the same call a program reallocs from larger to smaller and back to larger again the new space could contain stale data. Pass true for zero_init in this case, otherwise compute units will be wasted re-zero-initializing.

Safety

This method makes assumptions about the layout and location of memory referenced by AccountInfo fields. It should only be called for instances of AccountInfo that were created by the runtime and received in the process_instruction entrypoint of a program.

Trait Implementations

impl Clone for AccountInfo

fn clone(&self) -> AccountInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<&AccountInfo> for CAccountInfo

fn from(account: &AccountInfo) -> Self

Converts to this type from the input type.

impl From<&AccountInfo> for CAccountMeta

fn from(account: &AccountInfo) -> Self

Converts to this type from the input type.

impl PartialEq for AccountInfo

fn eq(&self, other: &AccountInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AccountInfo

impl StructuralPartialEq for AccountInfo