Struct ink_metadata::ConstructorSpecBuilder

pub struct ConstructorSpecBuilder<F: Form, Selector, IsPayable, Returns> { /* private fields */ }

A builder for constructors.

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<F, P, R> ConstructorSpecBuilder<F, Missing<Selector>, P, R>where
    F: Form,

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

Sets the function selector of the message.

impl<F, S, R> ConstructorSpecBuilder<F, S, Missing<IsPayable>, R>where
    F: Form,

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

Sets if the constructor is payable, thus accepting value for the caller.

impl<F, S, P> ConstructorSpecBuilder<F, S, P, Missing<Returns>>where
    F: Form,

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

Sets the return type of the message.

impl<F, S, P, R> ConstructorSpecBuilder<F, S, P, R>where
    F: Form,

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

Sets the input arguments of the message specification.

pub fn docs<'a, D>(self, docs: D) -> Selfwhere
    D: IntoIterator<Item = &'a str>,
    F::String: From<&'a str>,

Sets the documentation of the message specification.

impl<F> ConstructorSpecBuilder<F, Selector, IsPayable, Returns>where
    F: Form,

pub fn done(self) -> ConstructorSpec<F>

Finishes construction of the constructor.