Struct anchor_lang::Program
source · [−]pub struct Program<'info, T: Id + AccountDeserialize + Clone> { /* private fields */ }
Expand description
Account container that checks ownership on deserialization.
Implementations
sourceimpl<'a, T: Id + AccountDeserialize + Clone> Program<'a, T>
impl<'a, T: Id + AccountDeserialize + Clone> Program<'a, T>
sourcepub fn try_from(info: &AccountInfo<'a>) -> Result<Program<'a, T>, ProgramError>
pub fn try_from(info: &AccountInfo<'a>) -> Result<Program<'a, T>, ProgramError>
Deserializes the given info
into a Program
.
Methods from Deref<Target = AccountInfo<'info>>
pub fn signer_key(&self) -> Option<&Pubkey>
pub fn unsigned_key(&self) -> &Pubkey
pub fn lamports(&self) -> u64
pub fn try_lamports(&self) -> Result<u64, ProgramError>
pub fn data_len(&self) -> usize
pub fn try_data_len(&self) -> Result<usize, ProgramError>
pub fn data_is_empty(&self) -> bool
pub fn try_data_is_empty(&self) -> Result<bool, ProgramError>
pub fn try_borrow_lamports(&self) -> Result<Ref<'_, &mut u64>, ProgramError>
pub fn try_borrow_mut_lamports(
&self
) -> Result<RefMut<'_, &'a mut u64>, ProgramError>
pub fn try_borrow_data(&self) -> Result<Ref<'_, &mut [u8]>, ProgramError>
pub fn try_borrow_mut_data(
&self
) -> Result<RefMut<'_, &'a mut [u8]>, ProgramError>
sourcepub fn realloc(
&self,
new_len: usize,
zero_init: bool
) -> Result<(), ProgramError>
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.
pub fn assign(&self, new_owner: &Pubkey)
pub fn deserialize_data<T>(&self) -> Result<T, Box<ErrorKind, Global>> where
T: DeserializeOwned,
pub fn serialize_data<T>(&self, state: &T) -> Result<(), Box<ErrorKind, Global>> where
T: Serialize,
Trait Implementations
sourceimpl<'info, T: Id + Clone> Accounts<'info> for Program<'info, T> where
T: Id + AccountDeserialize,
impl<'info, T: Id + Clone> Accounts<'info> for Program<'info, T> where
T: Id + AccountDeserialize,
sourcefn try_accounts(
_program_id: &Pubkey,
accounts: &mut &[AccountInfo<'info>],
_ix_data: &[u8]
) -> Result<Self, ProgramError>
fn try_accounts(
_program_id: &Pubkey,
accounts: &mut &[AccountInfo<'info>],
_ix_data: &[u8]
) -> 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. Read more
sourceimpl<'info, T: AccountDeserialize + Id + Clone> AccountsExit<'info> for Program<'info, T>
impl<'info, T: AccountDeserialize + Id + Clone> AccountsExit<'info> for Program<'info, T>
sourcefn exit(&self, _program_id: &Pubkey) -> ProgramResult
fn exit(&self, _program_id: &Pubkey) -> ProgramResult
program_id
is the currently executing program.
sourceimpl<'info, T: Id + AccountDeserialize + Clone> AsRef<AccountInfo<'info>> for Program<'info, T>
impl<'info, T: Id + AccountDeserialize + Clone> AsRef<AccountInfo<'info>> for Program<'info, T>
sourcefn as_ref(&self) -> &AccountInfo<'info>
fn as_ref(&self) -> &AccountInfo<'info>
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl<'info, T: Id + AccountDeserialize + Clone> Deref for Program<'info, T>
impl<'info, T: Id + AccountDeserialize + Clone> Deref for Program<'info, T>
type Target = AccountInfo<'info>
type Target = AccountInfo<'info>
The resulting type after dereferencing.
sourceimpl<'info, T: Id + AccountDeserialize + Clone> ToAccountInfo<'info> for Program<'info, T>
impl<'info, T: Id + AccountDeserialize + Clone> ToAccountInfo<'info> for Program<'info, T>
fn to_account_info(&self) -> AccountInfo<'info>
sourceimpl<'info, T: Id + AccountDeserialize + Clone> ToAccountInfos<'info> for Program<'info, T>
impl<'info, T: Id + AccountDeserialize + Clone> ToAccountInfos<'info> for Program<'info, T>
fn to_account_infos(&self) -> Vec<AccountInfo<'info>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
sourceimpl<'info, T: Id + AccountDeserialize + Clone> ToAccountMetas for Program<'info, T>
impl<'info, T: Id + AccountDeserialize + Clone> ToAccountMetas for Program<'info, T>
sourcefn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
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. Read more
Auto Trait Implementations
impl<'info, T> !RefUnwindSafe for Program<'info, T>
impl<'info, T> !Send for Program<'info, T>
impl<'info, T> !Sync for Program<'info, T>
impl<'info, T> Unpin for Program<'info, T> where
T: Unpin,
impl<'info, T> !UnwindSafe for Program<'info, T>
Blanket Implementations
impl<T> AbiExample for T
impl<T> AbiExample for T
default fn example() -> T
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more