Struct ink_env::CallFlags

pub struct CallFlags { /* private fields */ }

The flags used to change the behavior of a contract call.

Implementations

impl CallFlags

pub const fn set_forward_input(self, forward_input: bool) -> Self

Forwards the input for the current function to the callee.

Note

A forwarding call will consume the current contracts input. Any attempt to access the input after this call returns (e.g. by trying another forwarding call) will lead to a contract revert. Consider using Self::set_clone_input in order to preserve the input.

pub const fn set_clone_input(self, clone_input: bool) -> Self

Identical to Self::set_forward_input but without consuming the input.

This adds some additional weight costs to the call.

Note

This implies Self::set_forward_input and takes precedence when both are set.

pub const fn set_tail_call(self, tail_call: bool) -> Self

Do not return from the call but rather return the result of the callee to the callers caller.

Note

This makes the current contract completely transparent to its caller by replacing this contracts potential output with the callee ones. Any code after the contract calls has been invoked can be safely considered unreachable.

pub const fn set_allow_reentry(self, allow_reentry: bool) -> Self

Allow the callee to reenter into the current contract.

Without this flag any reentrancy into the current contract that originates from the callee (or any of its callees) is denied. This includes the first callee: You cannot call into yourself with this flag set.

pub const fn forward_input(&self) -> bool

Returns true if input forwarding is set.

Note

See Self::set_forward_input for more information.

pub const fn clone_input(&self) -> bool

Returns true if input cloning is set.

Note

See Self::set_clone_input for more information.

pub const fn tail_call(&self) -> bool

Returns true if the tail call property is set.

Note

See Self::set_tail_call for more information.

pub const fn allow_reentry(&self) -> bool

Returns true if call reentry is allowed.

Note

See Self::set_allow_reentry for more information.

Trait Implementations

impl Clone for CallFlags

fn clone(&self) -> CallFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallFlags

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

Formats the value using the given formatter.

impl Default for CallFlags

fn default() -> CallFlags

Returns the “default value” for a type.

impl Copy for CallFlags