Struct TokenBatch 

pub struct TokenBatch<'a, const DATA: usize = 256, const ACCOUNTS: usize = 16> { /* private fields */ }

A stack-resident batch of token instructions.

DATA bounds the instruction data (one discriminator byte plus the headers and data of every pushed instruction) and ACCOUNTS bounds the account list. A push that would overflow either is refused with InvalidArgument and leaves the batch unchanged.

Implementations

impl<'a, const DATA: usize, const ACCOUNTS: usize> TokenBatch<'a, DATA, ACCOUNTS>

pub const fn new() -> Self

An empty batch. DATA must hold at least the discriminator.

pub fn push(&mut self, instruction: &impl TokenInstruction<'a>) -> ProgramResult

Append an instruction whose authority signs directly or through PDA seeds given at invoke time.

pub fn push_multisig( &mut self, instruction: &impl TokenInstruction<'a>, multisig_signers: &[&'a AccountView<'a>], ) -> ProgramResult

Append an instruction whose authority is a multisig with these signer accounts.

pub const fn len(&self) -> usize

How many instructions were pushed.

pub const fn is_empty(&self) -> bool

Whether nothing was pushed yet.

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

The instruction data as it will be sent: [255] then the headers and inner data.

pub fn account_metas(&self) -> &[InstructionAccount<'a>]

The account metas as they will be sent.

pub fn account_views(&self) -> &[&'a AccountView<'a>]

The account views as they will be sent, in meta order.

pub fn invoke(&self) -> ProgramResult

Send the batch to SPL Token.

pub fn invoke_signed(&self, signers: &[Signer<'_, '_>]) -> ProgramResult

Send the batch to SPL Token with PDA signers.

pub fn invoke_on( &self, program: TokenProgram, signers: &[Signer<'_, '_>], ) -> ProgramResult

Send the batch to an explicit token program. An empty batch is refused with InvalidArgument rather than sent.

Trait Implementations

impl<'a, const DATA: usize, const ACCOUNTS: usize> Default for TokenBatch<'a, DATA, ACCOUNTS>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, const DATA: usize, const ACCOUNTS: usize> TokenSink<'a> for TokenBatch<'a, DATA, ACCOUNTS>

fn emit<const N: usize>( &mut self, data: &[u8], accounts: [InstructionAccount<'a>; N], views: [&'a AccountView<'a>; N], trailing: &[Trailing<'_, 'a>], ) -> ProgramResult

Receive one encoded instruction: its data, its fixed account metas and views in order, and zero or more trailing runs appended after them.