algokit_transact

Struct PaymentTransactionBuilder

Source
pub struct PaymentTransactionBuilder { /* private fields */ }
Expand description

Implementations§

Source§

impl PaymentTransactionBuilder

Source

pub fn header(&mut self, value: TransactionHeader) -> &mut Self

Common transaction header fields.

Source

pub fn receiver(&mut self, value: Address) -> &mut Self

The address of the account receiving the ALGO payment.

Source

pub fn amount(&mut self, value: u64) -> &mut Self

The amount of microALGO to send.

Specified in microALGO (1 ALGO = 1,000,000 microALGO).

Source

pub fn close_remainder_to(&mut self, value: Address) -> &mut Self

Optional address to send all remaining funds to after the transfer.

If specified, this indicates that the sender account should be closed after the transaction, and all remaining funds (minus fees) should be transferred to the specified address. This effectively removes the sender account from the ledger.

Source

pub fn build_fields( &self, ) -> Result<PaymentTransactionFields, PaymentTransactionBuilderError>

Builds a new PaymentTransactionFields.

§Errors

If a required field has not been initialized.

Source§

impl PaymentTransactionBuilder

Source

pub fn build(&self) -> Result<Transaction, PaymentTransactionBuilderError>

Trait Implementations§

Source§

impl Clone for PaymentTransactionBuilder

Source§

fn clone(&self) -> PaymentTransactionBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for PaymentTransactionBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.