Struct ink_env::call::CallBuilder

source ·
pub struct CallBuilder<E, CallType, Args, RetType>where
    E: Environment,{ /* private fields */ }
Expand description

Builds up a cross contract call.

Implementations§

source§

impl<E, CallType, Args, RetType> CallBuilder<E, Unset<CallType>, Args, RetType>where E: Environment,

source

pub fn call_type<NewCallType>( self, call_type: NewCallType ) -> CallBuilder<E, Set<NewCallType>, Args, RetType>

The type of the call.

source§

impl<E, CallType, Args, RetType> CallBuilder<E, CallType, Args, RetType>where E: Environment,

source

pub fn call_flags( self, call_flags: CallFlags ) -> CallBuilder<E, CallType, Args, RetType>

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

source§

impl<E, CallType, Args> CallBuilder<E, CallType, Args, Unset<ReturnType<()>>>where E: Environment,

source

pub fn returns<R>(self) -> CallBuilder<E, CallType, Args, Set<ReturnType<R>>>

Sets the type of the returned value upon the execution of the call.

Note

Either use .returns::<()> to signal that the call does not return a value or use .returns::<T> to signal that the call returns a value of type T.

source§

impl<E, CallType, RetType> CallBuilder<E, CallType, Unset<ExecutionInput<EmptyArgumentList>>, RetType>where E: Environment,

source

pub fn exec_input<Args>( self, exec_input: ExecutionInput<Args> ) -> CallBuilder<E, CallType, Set<ExecutionInput<Args>>, RetType>

Sets the execution input to the given value.

source§

impl<E, CallType, Args, RetType> CallBuilder<E, Unset<CallType>, Args, RetType>where E: Environment,

source

pub fn call_v1( self, callee: E::AccountId ) -> CallBuilder<E, Set<CallV1<E>>, Args, RetType>

Prepares the CallBuilder for a cross-contract CallV1, calling into the original call host function.

source

pub fn call( self, callee: E::AccountId ) -> CallBuilder<E, Set<Call<E>>, Args, RetType>

Prepares the CallBuilder for a cross-contract Call to the latest call_v2 host function.

source

pub fn delegate( self, code_hash: E::Hash ) -> CallBuilder<E, Set<DelegateCall<E>>, Args, RetType>

Prepares the CallBuilder for a cross-contract DelegateCall.

source§

impl<E, Args, RetType> CallBuilder<E, Set<CallV1<E>>, Args, RetType>where E: Environment,

source

pub fn gas_limit(self, gas_limit: Gas) -> Self

Sets the gas_limit for the current cross-contract call.

source

pub fn transferred_value(self, transferred_value: E::Balance) -> Self

Sets the transferred_value for the current cross-contract call.

source§

impl<E, Args, RetType> CallBuilder<E, Set<Call<E>>, Args, RetType>where E: Environment,

source

pub fn call_v1(self) -> CallBuilder<E, Set<CallV1<E>>, Args, RetType>

Switch to the original call host function API, which only allows the gas_limit limit parameter (equivalent to the ref_time_limit in the latest call_v2).

This method instance is used to allow usage of the generated call builder methods for messages which initialize the builder with the new Call type.

source

pub fn ref_time_limit(self, ref_time_limit: Gas) -> Self

Sets the ref_time_limit part of the weight limit for the current cross-contract call.

ref_time refers to the amount of computational time that can be used for execution, in picoseconds. You can find more info here.

source

pub fn proof_size_limit(self, proof_size_limit: Gas) -> Self

Sets the proof_size_limit part of the weight limit for the current cross-contract call.

proof_size refers to the amount of storage in bytes that a transaction is allowed to read. You can find more info here.

Note

This limit is only relevant for parachains, not for standalone chains which do not require sending a Proof-of-validity to the relay chain.

source

pub fn storage_deposit_limit(self, storage_deposit_limit: E::Balance) -> Self

Sets the storage_deposit_limit for the current cross-contract call.

The storage_deposit_limit specifies the amount of user funds that can be charged for creating storage. You can find more info here.

source

pub fn transferred_value(self, transferred_value: E::Balance) -> Self

Sets the transferred_value for the current cross-contract call.

This value specifies the amount of user funds that are transferred to the other contract with this call.

source§

impl<E, Args, RetType> CallBuilder<E, Set<DelegateCall<E>>, Args, RetType>where E: Environment,

source

pub fn code_hash(self, code_hash: E::Hash) -> Self

Sets the code_hash to perform a delegate call with.

source§

impl<E, Args, RetType> CallBuilder<E, Set<CallV1<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where E: Environment,

source

pub fn params(self) -> CallParams<E, CallV1<E>, Args, RetType>

Finalizes the call builder to call a function.

source§

impl<E, Args, RetType> CallBuilder<E, Set<Call<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where E: Environment,

source

pub fn params(self) -> CallParams<E, Call<E>, Args, RetType>

Finalizes the call builder to call a function.

source§

impl<E, Args, RetType> CallBuilder<E, Set<DelegateCall<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where E: Environment,

source

pub fn params(self) -> CallParams<E, DelegateCall<E>, Args, RetType>

Finalizes the call builder to call a function.

source§

impl<E, RetType> CallBuilder<E, Set<CallV1<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where E: Environment,

source

pub fn params(self) -> CallParams<E, CallV1<E>, EmptyArgumentList, ()>

Finalizes the call builder to call a function.

source§

impl<E, RetType> CallBuilder<E, Set<Call<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where E: Environment,

source

pub fn params(self) -> CallParams<E, Call<E>, EmptyArgumentList, ()>

Finalizes the call builder to call a function.

source§

impl<E, RetType> CallBuilder<E, Set<DelegateCall<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where E: Environment,

source

pub fn params(self) -> CallParams<E, DelegateCall<E>, EmptyArgumentList, ()>

Finalizes the call builder to call a function.

source§

impl<E> CallBuilder<E, Set<CallV1<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where E: Environment,

source

pub fn invoke(self)

Invokes the cross-chain function call.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<()>, Error>

Invokes the cross-chain function call.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

source§

impl<E> CallBuilder<E, Set<Call<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where E: Environment,

source

pub fn invoke(self)

Invokes the cross-chain function call.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<()>, Error>

Invokes the cross-chain function call.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

source§

impl<E> CallBuilder<E, Set<DelegateCall<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where E: Environment,

source

pub fn invoke(self)

Invokes the cross-chain function call using Delegate Call semantics.

Panics

This method panics if it encounters an ink::env::Error If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<()>, Error>

Invokes the cross-chain function call using Delegate Call semantics.

Note

On failure this an ink::env::Error which can be handled by the caller.

source§

impl<E, Args, R> CallBuilder<E, Set<CallV1<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>where E: Environment, Args: Encode, R: Decode,

source

pub fn invoke(self) -> R

Invokes the cross-chain function call and returns the result.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<R>, Error>

Invokes the cross-chain function call and returns the result.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

source§

impl<E, Args, R> CallBuilder<E, Set<Call<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>where E: Environment, Args: Encode, R: Decode,

source

pub fn invoke(self) -> R

Invokes the cross-chain function call and returns the result.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<R>, Error>

Invokes the cross-chain function call and returns the result.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

source§

impl<E, Args, R> CallBuilder<E, Set<DelegateCall<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>where E: Environment, Args: Encode, R: Decode,

source

pub fn invoke(self) -> R

Invokes the cross-chain function call using Delegate Call semantics and returns the result.

Panics

This method panics if it encounters an ink::env::Error or an [ink::primitives::LangError][ink_primitives::LangError]. If you want to handle those use the try_invoke method instead.

source

pub fn try_invoke(self) -> Result<MessageResult<R>, Error>

Invokes the cross-chain function call using Delegate Call semantics and returns the result.

Note

On failure this returns an outer ink::env::Error or inner [ink::primitives::LangError][ink_primitives::LangError], both of which can be handled by the caller.

Trait Implementations§

source§

impl<E, CallType: Clone, Args: Clone, RetType: Clone> Clone for CallBuilder<E, CallType, Args, RetType>where E: Environment + Clone,

source§

fn clone(&self) -> CallBuilder<E, CallType, Args, RetType>

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

Auto Trait Implementations§

§

impl<E, CallType, Args, RetType> RefUnwindSafe for CallBuilder<E, CallType, Args, RetType>where Args: RefUnwindSafe, CallType: RefUnwindSafe, RetType: RefUnwindSafe,

§

impl<E, CallType, Args, RetType> Send for CallBuilder<E, CallType, Args, RetType>where Args: Send, CallType: Send, RetType: Send,

§

impl<E, CallType, Args, RetType> Sync for CallBuilder<E, CallType, Args, RetType>where Args: Sync, CallType: Sync, RetType: Sync,

§

impl<E, CallType, Args, RetType> Unpin for CallBuilder<E, CallType, Args, RetType>where Args: Unpin, CallType: Unpin, RetType: Unpin,

§

impl<E, CallType, Args, RetType> UnwindSafe for CallBuilder<E, CallType, Args, RetType>where Args: UnwindSafe, CallType: UnwindSafe, RetType: UnwindSafe,

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