Enum OnApplicationComplete

pub enum OnApplicationComplete {
    NoOp = 0,
    OptIn = 1,
    CloseOut = 2,
    ClearState = 3,
    UpdateApplication = 4,
    DeleteApplication = 5,
}

On-completion actions for app transactions.

These values define what additional actions occur with the transaction.

Variants

NoOp = 0

NoOp indicates that an app transaction will simply call its approval program without any additional action.

OptIn = 1

OptIn indicates that an app transaction will allocate some local state for the app in the sender’s account.

CloseOut = 2

CloseOut indicates that an app transaction will deallocate some local state for the app from the user’s account.

ClearState = 3

ClearState is similar to CloseOut, but may never fail. This allows users to reclaim their minimum balance from an app they no longer wish to opt in to.

UpdateApplication = 4

UpdateApplication indicates that an app transaction will update the approval program and clear state program for the app.

DeleteApplication = 5

DeleteApplication indicates that an app transaction will delete the app parameters for the app from the creator’s balance record.

Trait Implementations

impl Clone for OnApplicationComplete

fn clone(&self) -> OnApplicationComplete

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for OnApplicationComplete

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for OnApplicationComplete

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OnApplicationComplete

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for OnApplicationComplete

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<OnApplicationComplete> for OnApplicationComplete

fn from(value: OnApplicationComplete) -> Self

Converts to this type from the input type.

impl From<OnApplicationComplete> for OnApplicationComplete

fn from(val: OnApplicationComplete) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for OnApplicationComplete

type FfiType = <OnApplicationComplete as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for OnApplicationComplete

type LiftType = OnApplicationComplete

impl<UT> LiftReturn<UT> for OnApplicationComplete

type ReturnType = <OnApplicationComplete as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for OnApplicationComplete

type FfiType = <OnApplicationComplete as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for OnApplicationComplete

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for OnApplicationComplete

type ReturnType = <OnApplicationComplete as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for OnApplicationComplete

fn eq(&self, other: &OnApplicationComplete) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OnApplicationComplete

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for OnApplicationComplete

const TYPE_ID_META: MetadataBuffer

impl StructuralPartialEq for OnApplicationComplete