Struct ink_metadata::MessageSpecBuilder
source · pub struct MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where
F: Form,{ /* private fields */ }Expand description
A builder for messages.
Developer Note
Some fields are guarded by a type-state pattern to fail at compile-time instead of at run-time. This is useful to better debug code-gen macros.
Implementations§
source§impl<F, M, P, R> MessageSpecBuilder<F, Missing<Selector>, M, P, R>where
F: Form,
impl<F, M, P, R> MessageSpecBuilder<F, Missing<Selector>, M, P, R>where F: Form,
sourcepub fn selector(
self,
selector: [u8; 4]
) -> MessageSpecBuilder<F, Selector, M, P, R>
pub fn selector( self, selector: [u8; 4] ) -> MessageSpecBuilder<F, Selector, M, P, R>
Sets the function selector of the message.
source§impl<F, S, P, R> MessageSpecBuilder<F, S, Missing<Mutates>, P, R>where
F: Form,
impl<F, S, P, R> MessageSpecBuilder<F, S, Missing<Mutates>, P, R>where F: Form,
sourcepub fn mutates(self, mutates: bool) -> MessageSpecBuilder<F, S, Mutates, P, R>
pub fn mutates(self, mutates: bool) -> MessageSpecBuilder<F, S, Mutates, P, R>
Sets if the message is mutable, thus taking &mut self or not thus taking
&self.
source§impl<F, S, M, R> MessageSpecBuilder<F, S, M, Missing<IsPayable>, R>where
F: Form,
impl<F, S, M, R> MessageSpecBuilder<F, S, M, Missing<IsPayable>, R>where F: Form,
sourcepub fn payable(
self,
is_payable: bool
) -> MessageSpecBuilder<F, S, M, IsPayable, R>
pub fn payable( self, is_payable: bool ) -> MessageSpecBuilder<F, S, M, IsPayable, R>
Sets if the message is payable, thus accepting value for the caller.
source§impl<F, M, S, P> MessageSpecBuilder<F, S, M, P, Missing<Returns>>where
F: Form,
impl<F, M, S, P> MessageSpecBuilder<F, S, M, P, Missing<Returns>>where F: Form,
sourcepub fn returns(
self,
return_type: ReturnTypeSpec<F>
) -> MessageSpecBuilder<F, S, M, P, Returns>
pub fn returns( self, return_type: ReturnTypeSpec<F> ) -> MessageSpecBuilder<F, S, M, P, Returns>
Sets the return type of the message.
source§impl<F, S, M, P, R> MessageSpecBuilder<F, S, M, P, R>where
F: Form,
impl<F, S, M, P, R> MessageSpecBuilder<F, S, M, P, R>where F: Form,
sourcepub fn args<A>(self, args: A) -> Selfwhere
A: IntoIterator<Item = MessageParamSpec<F>>,
pub fn args<A>(self, args: A) -> Selfwhere A: IntoIterator<Item = MessageParamSpec<F>>,
Sets the input arguments of the message specification.
sourcepub fn docs<D>(self, docs: D) -> Selfwhere
D: IntoIterator<Item = <F as Form>::String>,
pub fn docs<D>(self, docs: D) -> Selfwhere D: IntoIterator<Item = <F as Form>::String>,
Sets the documentation of the message specification.
source§impl<F> MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where
F: Form,
impl<F> MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where F: Form,
sourcepub fn done(self) -> MessageSpec<F>
pub fn done(self) -> MessageSpec<F>
Finishes construction of the message.
Auto Trait Implementations§
impl<F, Selector, Mutates, IsPayable, Returns> RefUnwindSafe for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where <F as Form>::String: RefUnwindSafe, <F as Form>::Type: RefUnwindSafe,
impl<F, Selector, Mutates, IsPayable, Returns> Send for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where <F as Form>::String: Send, <F as Form>::Type: Send,
impl<F, Selector, Mutates, IsPayable, Returns> Sync for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where <F as Form>::String: Sync, <F as Form>::Type: Sync,
impl<F, Selector, Mutates, IsPayable, Returns> Unpin for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where <F as Form>::String: Unpin, <F as Form>::Type: Unpin,
impl<F, Selector, Mutates, IsPayable, Returns> UnwindSafe for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>where <F as Form>::String: UnwindSafe, <F as Form>::Type: UnwindSafe,
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
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
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,
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,
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,
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,
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,
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,
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,
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,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere 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) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere 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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere 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) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere 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) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere 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)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere 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)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere 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)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere 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)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere 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)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere 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
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
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)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere 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)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere 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)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere 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)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.