Struct ink_env::CallFlags

pub struct CallFlags { /* private fields */ }
Expand description

Flags used to change the behaviour of seal_call and seal_delegate_call.

Implementations§

§

impl CallFlags

pub const FORWARD_INPUT: CallFlags = _

Forward the input of current function to the callee.

Supplied input pointers are ignored when set.

Note

A forwarding call will consume the current contracts input. Any attempt to access the input after this call returns will lead to [Error::InputForwarded]. It does not matter if this is due to calling seal_input or trying another forwarding call. Consider using Self::CLONE_INPUT in order to preserve the input.

pub const CLONE_INPUT: CallFlags = _

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

This adds some additional weight costs to the call.

Note

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

pub const TAIL_CALL: CallFlags = _

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 by the callee ones. Any code after seal_call can be safely considered unreachable.

pub const ALLOW_REENTRY: CallFlags = _

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.

Note

For seal_delegate_call should be always unset, otherwise [Error::InvalidCallFlags] is returned.

pub const fn empty() -> CallFlags

Returns an empty set of flags.

pub const fn all() -> CallFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<CallFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> CallFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> CallFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: CallFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: CallFlags) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: CallFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: CallFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: CallFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: CallFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: CallFlags) -> CallFlags

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: CallFlags) -> CallFlags

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: CallFlags) -> CallFlags

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: CallFlags) -> CallFlags

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> CallFlags

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations§

§

impl Binary for CallFlags

§

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

Formats the value using the given formatter.
§

impl BitAnd for CallFlags

§

fn bitand(self, other: CallFlags) -> CallFlags

Returns the intersection between the two sets of flags.

§

type Output = CallFlags

The resulting type after applying the & operator.
§

impl BitAndAssign for CallFlags

§

fn bitand_assign(&mut self, other: CallFlags)

Disables all flags disabled in the set.

§

impl BitOr for CallFlags

§

fn bitor(self, other: CallFlags) -> CallFlags

Returns the union of the two sets of flags.

§

type Output = CallFlags

The resulting type after applying the | operator.
§

impl BitOrAssign for CallFlags

§

fn bitor_assign(&mut self, other: CallFlags)

Adds the set of flags.

§

impl BitXor for CallFlags

§

fn bitxor(self, other: CallFlags) -> CallFlags

Returns the left flags, but with all the right flags toggled.

§

type Output = CallFlags

The resulting type after applying the ^ operator.
§

impl BitXorAssign for CallFlags

§

fn bitxor_assign(&mut self, other: CallFlags)

Toggles the set of flags.

§

impl Clone for CallFlags

§

fn clone(&self) -> CallFlags

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
§

impl Debug for CallFlags

§

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

Formats the value using the given formatter. Read more
§

impl Extend<CallFlags> for CallFlags

§

fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = CallFlags>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
§

impl FromIterator<CallFlags> for CallFlags

§

fn from_iter<T>(iterator: T) -> CallFlagswhere T: IntoIterator<Item = CallFlags>,

Creates a value from an iterator. Read more
§

impl Hash for CallFlags

§

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
§

impl LowerHex for CallFlags

§

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

Formats the value using the given formatter.
§

impl Not for CallFlags

§

fn not(self) -> CallFlags

Returns the complement of this set of flags.

§

type Output = CallFlags

The resulting type after applying the ! operator.
§

impl Octal for CallFlags

§

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

Formats the value using the given formatter.
§

impl Ord for CallFlags

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for CallFlags

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialOrd for CallFlags

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Sub for CallFlags

§

fn sub(self, other: CallFlags) -> CallFlags

Returns the set difference of the two sets of flags.

§

type Output = CallFlags

The resulting type after applying the - operator.
§

impl SubAssign for CallFlags

§

fn sub_assign(&mut self, other: CallFlags)

Disables all flags enabled in the set.

§

impl UpperHex for CallFlags

§

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

Formats the value using the given formatter.
§

impl Copy for CallFlags

§

impl Eq for CallFlags

§

impl StructuralEq for CallFlags

§

impl StructuralPartialEq for CallFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere 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, U> Into<U> for Twhere 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

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V