Struct ink_metadata::MessageSpecBuilder

pub struct MessageSpecBuilder<Selector, Mutates, IsPayable, Returns> { /* fields omitted */ }

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

impl<M, P, R> MessageSpecBuilder<Missing<Selector>, M, P, R>

pub fn selector(
    self,
    selector: [u8; 4]
) -> MessageSpecBuilder<Selector, M, P, R>

Sets the function selector of the message.

impl<S, P, R> MessageSpecBuilder<S, Missing<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.

impl<S, M, R> MessageSpecBuilder<S, M, Missing<IsPayable>, R>

pub fn payable(self, is_payable: bool) -> MessageSpecBuilder<S, M, IsPayable, R>

Sets if the message is mutable, thus taking &mut self or not thus taking &self.

impl<M, S, P> MessageSpecBuilder<S, M, P, Missing<Returns>>

pub fn returns(
    self,
    return_type: ReturnTypeSpec
) -> MessageSpecBuilder<S, M, P, Returns>

Sets the return type of the message.

impl<S, M, P, R> MessageSpecBuilder<S, M, P, R>

pub fn args<A>(self, args: A) -> Self where
    A: IntoIterator<Item = MessageParamSpec>, 

Sets the input arguments of the message specification.

pub fn docs<D>(self, docs: D) -> Self where
    D: IntoIterator<Item = &'static str>, 

Sets the documentation of the message specification.

impl MessageSpecBuilder<Selector, Mutates, IsPayable, Returns>

pub fn done(self) -> MessageSpec

Finishes construction of the message.