Struct anchor_lang::ProgramAccount

pub struct ProgramAccount<'info, T: AccountSerialize + AccountDeserialize + Clone> { /* private fields */ }

Boxed container for a deserialized account. Use this to reference any account owned by the currently executing program.

Implementations

impl<'a, T: AccountSerialize + AccountDeserialize + Clone> ProgramAccount<'a, T>

pub fn new(info: AccountInfo<'a>, account: T) -> ProgramAccount<'a, T>

pub fn try_from(
    info: &AccountInfo<'a>
) -> Result<ProgramAccount<'a, T>, ProgramError>

Deserializes the given info into a ProgramAccount.

pub fn try_from_init(
    info: &AccountInfo<'a>
) -> Result<ProgramAccount<'a, T>, ProgramError>

Deserializes the zero-initialized info into a ProgramAccount without checking the account type. This should only be used upon program account initialization (since the entire account data array is zeroed and thus no account type is set).

Trait Implementations

impl<'info, T> Accounts<'info> for ProgramAccount<'info, T> where
    T: AccountSerialize + AccountDeserialize + Clone, 

fn try_accounts(
    program_id: &Pubkey,
    accounts: &mut &[AccountInfo<'info>]
) -> Result<Self, ProgramError>

Returns the validated accounts struct. What constitutes “valid” is program dependent. However, users of these types should never have to worry about account substitution attacks. For example, if a program expects a Mint account from the SPL token program in a particular field, then it should be impossible for this method to return Ok if any other account type is given–from the SPL token program or elsewhere.

impl<'info, T: AccountSerialize + AccountDeserialize + Clone> AccountsClose<'info> for ProgramAccount<'info, T>

fn close(&self, sol_destination: AccountInfo<'info>) -> ProgramResult

impl<'info, T: AccountSerialize + AccountDeserialize + Clone> AccountsExit<'info> for ProgramAccount<'info, T>

fn exit(&self, _program_id: &Pubkey) -> ProgramResult

program_id is the currently executing program.

impl<'info, T> AccountsInit<'info> for ProgramAccount<'info, T> where
    T: AccountSerialize + AccountDeserialize + Clone, 

fn try_accounts_init(
    program_id: &Pubkey,
    accounts: &mut &[AccountInfo<'info>]
) -> Result<Self, ProgramError>

impl<'info, T: Clone + AccountSerialize + AccountDeserialize + Clone> Clone for ProgramAccount<'info, T>

fn clone(&self) -> ProgramAccount<'info, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: AccountSerialize + AccountDeserialize + Clone> Deref for ProgramAccount<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: AccountSerialize + AccountDeserialize + Clone> DerefMut for ProgramAccount<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'info, T> From<CpiAccount<'info, T>> for ProgramAccount<'info, T> where
    T: AccountSerialize + AccountDeserialize + Clone, 

fn from(a: CpiAccount<'info, T>) -> Self

Converts to this type from the input type.

impl<'info, T: AccountSerialize + AccountDeserialize + Clone> ToAccountInfo<'info> for ProgramAccount<'info, T>

fn to_account_info(&self) -> AccountInfo<'info>

impl<'info, T: AccountSerialize + AccountDeserialize + Clone> ToAccountInfos<'info> for ProgramAccount<'info, T>

fn to_account_infos(&self) -> Vec<AccountInfo<'info>>

impl<'info, T: AccountSerialize + AccountDeserialize + Clone> ToAccountMetas for ProgramAccount<'info, T>

fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>

is_signer is given as an optional override for the signer meta field. This covers the edge case when a program-derived-address needs to relay a transaction from a client to another program but sign the transaction before the relay. The client cannot mark the field as a signer, and so we have to override the is_signer meta field given by the client.