Struct ink_metadata::MessageSpecBuilder
source · [−]pub struct MessageSpecBuilder<Selector, Mutates, IsPayable, Returns> { /* 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
sourceimpl<M, P, R> MessageSpecBuilder<Missing<Selector>, M, P, R>
impl<M, P, R> MessageSpecBuilder<Missing<Selector>, M, P, R>
sourcepub fn selector(self, selector: [u8; 4]) -> MessageSpecBuilder<Selector, M, P, R>
pub fn selector(self, selector: [u8; 4]) -> MessageSpecBuilder<Selector, M, P, R>
Sets the function selector of the message.
sourceimpl<S, P, R> MessageSpecBuilder<S, Missing<Mutates>, P, R>
impl<S, P, R> MessageSpecBuilder<S, Missing<Mutates>, P, R>
sourcepub fn mutates(self, mutates: bool) -> MessageSpecBuilder<S, Mutates, P, R>
pub fn mutates(self, mutates: bool) -> MessageSpecBuilder<S, Mutates, P, R>
Sets if the message is mutable, thus taking &mut self
or not thus taking &self
.
sourceimpl<S, M, R> MessageSpecBuilder<S, M, Missing<IsPayable>, R>
impl<S, M, R> MessageSpecBuilder<S, M, Missing<IsPayable>, R>
sourcepub fn payable(self, is_payable: bool) -> MessageSpecBuilder<S, M, IsPayable, R>
pub fn payable(self, is_payable: bool) -> MessageSpecBuilder<S, M, IsPayable, R>
Sets if the message is payable, thus accepting value for the caller.
sourceimpl<M, S, P> MessageSpecBuilder<S, M, P, Missing<Returns>>
impl<M, S, P> MessageSpecBuilder<S, M, P, Missing<Returns>>
sourcepub fn returns(
self,
return_type: ReturnTypeSpec
) -> MessageSpecBuilder<S, M, P, Returns>
pub fn returns(
self,
return_type: ReturnTypeSpec
) -> MessageSpecBuilder<S, M, P, Returns>
Sets the return type of the message.
sourceimpl<S, M, P, R> MessageSpecBuilder<S, M, P, R>
impl<S, M, P, R> MessageSpecBuilder<S, M, P, R>
sourcepub fn args<A>(self, args: A) -> Selfwhere
A: IntoIterator<Item = MessageParamSpec>,
pub fn args<A>(self, args: A) -> Selfwhere
A: IntoIterator<Item = MessageParamSpec>,
Sets the input arguments of the message specification.
sourcepub fn docs<D>(self, docs: D) -> Selfwhere
D: IntoIterator<Item = &'static str>,
pub fn docs<D>(self, docs: D) -> Selfwhere
D: IntoIterator<Item = &'static str>,
Sets the documentation of the message specification.
sourceimpl MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
impl MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
sourcepub fn done(self) -> MessageSpec
pub fn done(self) -> MessageSpec
Finishes construction of the message.
Auto Trait Implementations
impl<Selector, Mutates, IsPayable, Returns> RefUnwindSafe for MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
impl<Selector, Mutates, IsPayable, Returns> Send for MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
impl<Selector, Mutates, IsPayable, Returns> Sync for MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
impl<Selector, Mutates, IsPayable, Returns> Unpin for MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
impl<Selector, Mutates, IsPayable, Returns> UnwindSafe for MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more