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,
impl<E, CallType, Args, RetType> CallBuilder<E, Unset<CallType>, Args, RetType>where
E: Environment,
sourcepub fn call_type<NewCallType>(
self,
call_type: NewCallType
) -> CallBuilder<E, Set<NewCallType>, Args, RetType>
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,
impl<E, CallType, Args, RetType> CallBuilder<E, CallType, Args, RetType>where
E: Environment,
sourcepub fn call_flags(
self,
call_flags: CallFlags
) -> CallBuilder<E, CallType, Args, RetType>
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,
impl<E, CallType, Args> CallBuilder<E, CallType, Args, Unset<ReturnType<()>>>where
E: Environment,
sourcepub fn returns<R>(self) -> CallBuilder<E, CallType, Args, Set<ReturnType<R>>>
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,
impl<E, CallType, RetType> CallBuilder<E, CallType, Unset<ExecutionInput<EmptyArgumentList>>, RetType>where
E: Environment,
sourcepub fn exec_input<Args>(
self,
exec_input: ExecutionInput<Args>
) -> CallBuilder<E, CallType, Set<ExecutionInput<Args>>, RetType>
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,
impl<E, CallType, Args, RetType> CallBuilder<E, Unset<CallType>, Args, RetType>where
E: Environment,
sourcepub fn call_v1(
self,
callee: E::AccountId
) -> CallBuilder<E, Set<CallV1<E>>, Args, RetType>
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.
sourcepub fn call(
self,
callee: E::AccountId
) -> CallBuilder<E, Set<Call<E>>, Args, RetType>
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.
sourcepub fn delegate(
self,
code_hash: E::Hash
) -> CallBuilder<E, Set<DelegateCall<E>>, Args, RetType>
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,
impl<E, Args, RetType> CallBuilder<E, Set<CallV1<E>>, Args, RetType>where
E: Environment,
source§impl<E, Args, RetType> CallBuilder<E, Set<Call<E>>, Args, RetType>where
E: Environment,
impl<E, Args, RetType> CallBuilder<E, Set<Call<E>>, Args, RetType>where
E: Environment,
sourcepub fn call_v1(self) -> CallBuilder<E, Set<CallV1<E>>, Args, RetType>
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.
sourcepub fn ref_time_limit(self, ref_time_limit: Gas) -> Self
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.
sourcepub fn proof_size_limit(self, proof_size_limit: Gas) -> Self
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.
sourcepub fn storage_deposit_limit(self, storage_deposit_limit: E::Balance) -> Self
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.
sourcepub fn transferred_value(self, transferred_value: E::Balance) -> Self
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,
impl<E, Args, RetType> CallBuilder<E, Set<DelegateCall<E>>, Args, RetType>where
E: Environment,
source§impl<E, Args, RetType> CallBuilder<E, Set<CallV1<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where
E: Environment,
impl<E, Args, RetType> CallBuilder<E, Set<CallV1<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, CallV1<E>, Args, RetType>
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,
impl<E, Args, RetType> CallBuilder<E, Set<Call<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, Call<E>, Args, RetType>
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,
impl<E, Args, RetType> CallBuilder<E, Set<DelegateCall<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<RetType>>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, DelegateCall<E>, Args, RetType>
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,
impl<E, RetType> CallBuilder<E, Set<CallV1<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, CallV1<E>, EmptyArgumentList, ()>
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,
impl<E, RetType> CallBuilder<E, Set<Call<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, Call<E>, EmptyArgumentList, ()>
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,
impl<E, RetType> CallBuilder<E, Set<DelegateCall<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<RetType>>where
E: Environment,
sourcepub fn params(self) -> CallParams<E, DelegateCall<E>, EmptyArgumentList, ()>
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,
impl<E> CallBuilder<E, Set<CallV1<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where
E: Environment,
sourcepub fn invoke(self)
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
. If you want to handle
those use the try_invoke
method instead.
sourcepub fn try_invoke(self) -> Result<MessageResult<()>, Error>
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
, 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,
impl<E> CallBuilder<E, Set<Call<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where
E: Environment,
sourcepub fn invoke(self)
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
. If you want to handle
those use the try_invoke
method instead.
sourcepub fn try_invoke(self) -> Result<MessageResult<()>, Error>
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
, 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,
impl<E> CallBuilder<E, Set<DelegateCall<E>>, Unset<ExecutionInput<EmptyArgumentList>>, Unset<ReturnType<()>>>where
E: Environment,
sourcepub fn invoke(self)
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.
sourcepub fn try_invoke(self) -> Result<MessageResult<()>, Error>
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>>>
impl<E, Args, R> CallBuilder<E, Set<CallV1<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>
sourcepub fn invoke(self) -> R
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
. If you want to handle
those use the try_invoke
method instead.
sourcepub fn try_invoke(self) -> Result<MessageResult<R>, Error>
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
, 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>>>
impl<E, Args, R> CallBuilder<E, Set<Call<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>
sourcepub fn invoke(self) -> R
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
. If you want to handle
those use the try_invoke
method instead.
sourcepub fn try_invoke(self) -> Result<MessageResult<R>, Error>
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
, 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>>>
impl<E, Args, R> CallBuilder<E, Set<DelegateCall<E>>, Set<ExecutionInput<Args>>, Set<ReturnType<R>>>
sourcepub fn invoke(self) -> R
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
. If you want to handle
those use the try_invoke
method instead.
sourcepub fn try_invoke(self) -> Result<MessageResult<R>, Error>
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
, 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,
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>
fn clone(&self) -> CallBuilder<E, CallType, Args, RetType>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl<E, CallType, Args, RetType> RefUnwindSafe for CallBuilder<E, CallType, Args, RetType>
impl<E, CallType, Args, RetType> Send for CallBuilder<E, CallType, Args, RetType>
impl<E, CallType, Args, RetType> Sync for CallBuilder<E, CallType, Args, RetType>
impl<E, CallType, Args, RetType> Unpin for CallBuilder<E, CallType, Args, RetType>
impl<E, CallType, Args, RetType> UnwindSafe for CallBuilder<E, CallType, Args, RetType>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.