Skip to main content

AccountInfo

Struct AccountInfo 

Source
#[repr(C)]
pub struct AccountInfo<'a> { pub key: &'a Pubkey, pub lamports: Rc<RefCell<&'a mut u64>>, pub utxo: &'a UtxoMeta, pub data: Rc<RefCell<&'a mut [u8]>>, pub owner: &'a Pubkey, pub is_signer: bool, pub is_writable: bool, pub is_executable: bool, }
Expand description

Account information that is passed to programs during instruction execution. The account’s data contains the actual account state managed by programs.

Fields§

§key: &'a Pubkey§lamports: Rc<RefCell<&'a mut u64>>

The lamports in the account. Modifiable by programs.

§utxo: &'a UtxoMeta§data: Rc<RefCell<&'a mut [u8]>>§owner: &'a Pubkey§is_signer: bool§is_writable: bool§is_executable: bool

Implementations§

Source§

impl<'a> AccountInfo<'a>

Source

pub fn new( key: &'a Pubkey, lamports: &'a mut u64, data: &'a mut [u8], owner: &'a Pubkey, utxo: &'a UtxoMeta, is_signer: bool, is_writable: bool, is_executable: bool, ) -> Self

Creates a new AccountInfo instance.

§Arguments
  • key - The account’s public key
  • data - The account’s mutable data
  • owner - The program that owns this account
  • utxo - The UTXO metadata associated with this account
  • is_signer - Whether this account is a signer
  • is_writable - Whether this account is writable
  • is_executable - Whether this account contains executable code
Source

pub fn data_len(&self) -> usize

Returns the length of the account’s data.

§Returns

The length of the account’s data in bytes

Source

pub fn try_data_len(&self) -> Result<usize, ProgramError>

Source

pub fn data_is_empty(&self) -> bool

Source

pub fn try_data_is_empty(&self) -> Result<bool, ProgramError>

Source

pub fn signer_key(&self) -> Option<&Pubkey>

Source

pub fn unsigned_key(&self) -> &Pubkey

Source

pub fn lamports(&self) -> u64

Source

pub fn try_lamports(&self) -> Result<u64, ProgramError>

Source

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

Source

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

Source

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

Immutably borrows the account’s data.

§Returns
  • Ok(Ref<&mut [u8]>) - A reference to the account’s data
  • Err(ProgramError) - If the data is already mutably borrowed
Source

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

Mutably borrows the account’s data.

§Returns
  • Ok(RefMut<&mut [u8]>) - A mutable reference to the account’s data
  • Err(ProgramError) - If the data is already borrowed
Source

pub unsafe fn original_data_len(&self) -> usize

Return the account’s original data length when it was serialized for the current program invocation.

§Safety

This method assumes that the original data length was serialized as a u64 integer in the 1 bytes immediately succeeding is_executable.

Source

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.

Source

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

Sets a new owner for the account.

§Arguments
  • owner - The public key of the new owner program
§Safety

This method uses unsafe operations to modify a non-mutable reference. It should only be used in contexts where this operation is valid.

Source

pub fn get_utxo(&self) -> &UtxoMeta

Trait Implementations§

Source§

impl<'a> AsRef<AccountInfo<'a>> for AccountInfo<'a>

Source§

fn as_ref(&self) -> &AccountInfo<'a>

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<'a> Clone for AccountInfo<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccountInfo<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<'a> Freeze for AccountInfo<'a>

§

impl<'a> Unpin for AccountInfo<'a>

§

impl<'a> UnsafeUnpin for AccountInfo<'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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.