ink_env::call

Struct 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, Args, RetType> CallBuilder<E, Set<Call>, Args, RetType>
where E: Environment,

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: U256) -> 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: U256) -> 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

pub fn call_flags(self, call_flags: CallFlags) -> Self

Sets the call_flags for the current cross-contract call.

These flags are used to change the behavior of the contract call.

Source§

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

Source

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

Finalizes the call builder to call a function.

Source§

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

Source

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

Finalizes the call builder to call a function.

Source§

impl<E, Abi> CallBuilder<E, Set<Call>, Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>, Unset<ReturnType<()>>>
where E: Environment, EmptyArgumentList<Abi>: AbiEncodeWith<Abi>, (): AbiDecodeWith<Abi> + DecodeMessageResult<Abi>, Abi: Default,

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, Args, R, Abi> CallBuilder<E, Set<Call>, Set<ExecutionInput<Args, Abi>>, Set<ReturnType<R>>>
where E: Environment, Args: AbiEncodeWith<Abi>, R: AbiDecodeWith<Abi> + DecodeMessageResult<Abi>, Abi: Default,

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, RetType> CallBuilder<E, Set<DelegateCall>, Args, RetType>
where E: Environment,

Source

pub fn address(self, address: H160) -> Self

Sets the address to perform a delegate call with.

Source

pub fn call_flags(self, call_flags: CallFlags) -> Self

Sets the CallFlags to perform a delegate call with.

Source§

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

Source

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

Finalizes the call builder to call a function.

Source§

impl<E, RetType, Abi> CallBuilder<E, Set<DelegateCall>, Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>, Unset<RetType>>
where E: Environment, EmptyArgumentList<Abi>: AbiEncodeWith<Abi>, (): AbiDecodeWith<Abi> + DecodeMessageResult<Abi>, Abi: Default,

Source

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

Finalizes the call builder to call a function.

Source§

impl<E, Abi> CallBuilder<E, Set<DelegateCall>, Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>, Unset<ReturnType<()>>>
where E: Environment, EmptyArgumentList<Abi>: AbiEncodeWith<Abi>, (): AbiDecodeWith<Abi> + DecodeMessageResult<Abi>, Abi: Default,

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, Abi> CallBuilder<E, Set<DelegateCall>, Set<ExecutionInput<Args, Abi>>, Set<ReturnType<R>>>
where E: Environment, Args: AbiEncodeWith<Abi>, R: AbiDecodeWith<Abi> + DecodeMessageResult<Abi>,

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.

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> 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, Abi> CallBuilder<E, CallType, Unset<ExecutionInput<EmptyArgumentList<Abi>, Abi>>, RetType>
where E: Environment,

Source

pub fn exec_input<Args>( self, exec_input: ExecutionInput<Args, Abi>, ) -> CallBuilder<E, CallType, Set<ExecutionInput<Args, Abi>>, 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(self, callee: H160) -> CallBuilder<E, Set<Call>, Args, RetType>

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

Source

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

Prepares the CallBuilder for a cross-contract DelegateCall.

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

impl<E, Args, RetType, Abi> From<Execution<Args, RetType, Abi>> for CallBuilder<E, Unset<Call>, Set<ExecutionInput<Args, Abi>>, Set<ReturnType<RetType>>>
where E: Environment,

Source§

fn from(invoke: Execution<Args, RetType, Abi>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

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
§

impl<T> CheckedConversion for T

§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. 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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

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

Source§

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

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T, U> IntoKey<U> for T
where U: FromKey<T>,

§

fn into_key(self) -> U

§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

§

fn into_tuple(self) -> Dest

§

impl<T> IsType<T> for T

§

fn from_ref(t: &T) -> &T

Cast reference.
§

fn into_ref(&self) -> &T

Cast reference.
§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.
§

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

Cast mutable reference.
§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> SaturatedConversion for T

§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

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

impl<T, U> TryIntoKey<U> for T
where U: TryFromKey<T>,

§

type Error = <U as TryFromKey<T>>::Error

§

fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>

§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,