Skip to main content

InvokeFlag

Struct InvokeFlag 

Source
#[repr(transparent)]
pub struct InvokeFlag(pub i32);
Expand description

Flags that modify the behavior of a contract invocation.

These flags are used with the Invoke syscall to control how a subinvocation executes. They are combined using bitwise OR.

Note: InvokeFlagSet is NOT part of the Invocation struct itself, but is instead a parameter to the Invoke syscall. The root transaction invocation always has no flags set (equivalent to None).

Tuple Fields§

§0: i32

Implementations§

Source§

impl InvokeFlag

Source

pub const None: InvokeFlag

No special behavior (default).

Source

pub const TryInvoke: InvokeFlag

Enable early conflict detection for parallel execution.

Thruput executes transactions in parallel without observing other transactions’ writes. After execution, a two-phase commit process commits writes to the database. If there’s a conflict, the entire transaction aborts.

TryInvoke pulls this conflict detection earlier: when a try_invoke frame finishes, it performs two-phase commit lock acquisition immediately. If any lock fails, the subinvocation frame reverts (but the caller can handle this gracefully).

This is nondeterministic, so the two-phase commit result (a boolean) is appended to the nondeterministic_bits in NondeterministicProposalData for deterministic re-execution by validators.

Source

pub const ReadOnly: InvokeFlag

Prevent all state modifications in the subinvocation.

The subinvocation can read storage but cannot write, deploy contracts, or perform any other state-modifying operations.

Source

pub const DelegateCall: InvokeFlag

Execute the target contract’s code in the caller’s context.

Similar to Ethereum’s DELEGATECALL: the invoked code runs with the caller’s storage and address context, allowing library-like code reuse.

TODO: This flag is not yet implemented. When implementing, provide a comprehensive specification of what changes and what doesn’t change in a delegatecall frame. For example, GetMsgSender and GetCurrentAddress should NOT change (they return the original caller and current address), but storage operations should operate on the caller’s storage. Document the behavior of all syscalls in a delegatecall context.

Trait Implementations§

Source§

impl Clone for InvokeFlag

Source§

fn clone(&self) -> InvokeFlag

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConstMaxSize for InvokeFlag

Source§

const MAX_SIZE: Option<usize>

Worst-case CXS encoded size in bytes, or None if unbounded.
Source§

impl ConstMaxSize for InvokeFlag

Source§

const MAX_SIZE: Option<usize>

Worst-case TXS encoded size in bytes, or None if unbounded.
Source§

impl Copy for InvokeFlag

Source§

impl Debug for InvokeFlag

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for InvokeFlag

Available on crate feature std only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl EncodesAs<InvokeFlag> for InvokeFlag

Source§

impl Eq for InvokeFlag

Source§

impl From<i32> for InvokeFlag

Source§

fn from(v: i32) -> InvokeFlag

Converts to this type from the input type.
Source§

impl Hash for InvokeFlag

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl JsonSchema for InvokeFlag

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Ord for InvokeFlag

Source§

fn cmp(&self, other: &InvokeFlag) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for InvokeFlag

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for InvokeFlag

Source§

fn partial_cmp(&self, other: &InvokeFlag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'_r> ReadXDR<'_r> for InvokeFlag

Source§

fn read_xdr<R>(r: &mut R) -> Result<InvokeFlag, ReadError>
where R: Reader<'_r>,

Reads an XDR value from the reader. Read more
Source§

fn read_xdr_in_place<R, '__xdrs_s>( r: &mut R, __xdrs_slot: Slot<'__xdrs_s, InvokeFlag>, ) -> Result<Init<'__xdrs_s, InvokeFlag>, ReadError>
where R: Reader<'_r>,

Reads an XDR value directly into slot, without first building it on the stack. Read more
Source§

impl StructuralPartialEq for InvokeFlag

Source§

impl WriteXDR for InvokeFlag

Source§

fn write_xdr<F, W>(&self, w: &mut W) -> Result<(), WriteError>
where W: Writer<F>,

Writes this value as XDR data to the writer. Read more
Source§

unsafe fn write_xdr_unchecked<F, W>(&self, w: &mut W)
where W: WriterUnchecked<F>,

Writes this value as XDR data to the writer, without runtime checks. 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Context for T
where T: Any + Display,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Hash for T
where T: WriteXDR,

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> ReadXDROwned for T
where T: for<'r> ReadXDR<'r>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> StaticIfNoAlloc for T

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.