ink_metadata

Struct 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,

Source

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,

Source

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,

Source

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,

Source

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,

Source

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

Sets the input arguments of the message specification.

Source

pub fn docs<D>(self, docs: D) -> Self
where D: IntoIterator<Item = <F as Form>::String>,

Sets the documentation of the message specification.

Source

pub fn default(self, default: bool) -> Self

Sets the default of the message specification.

Source§

impl<F> MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>
where F: Form,

Source

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

Finishes construction of the message.

Auto Trait Implementations§

§

impl<F, Selector, Mutates, IsPayable, Returns> Freeze for MessageSpecBuilder<F, Selector, Mutates, IsPayable, Returns>
where <F as Form>::String: Freeze, <F as Form>::Type: Freeze,

§

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

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