Struct ink_metadata::MessageSpec

pub struct MessageSpec<F: Form = MetaForm> { /* fields omitted */ }

Describes a contract message.

Implementations

impl MessageSpec

pub fn from_name(
    name: &'static str
) -> MessageSpecBuilder<Missing<Selector>, Missing<Mutates>, Missing<IsPayable>, Missing<Returns>>

Creates a new message spec builder.

pub fn from_trait_and_name(
    trait_name: &'static str,
    message_name: &'static str
) -> MessageSpecBuilder<Missing<Selector>, Missing<Mutates>, Missing<IsPayable>, Missing<Returns>>

Creates a new message spec builder for a trait provided message.

impl<F> MessageSpec<F> where
    F: Form, 

pub fn name(&self) -> &[F::String]

Returns the name of the message and some optional prefixes.

In case of trait provided messages and constructors the prefix by convention in ink! is the name of the trait.

pub fn selector(&self) -> &Selector

Returns the selector hash of the message.

pub fn mutates(&self) -> bool

Returns true if the message is allowed to mutate the contract state.

pub fn payable(&self) -> bool

Returns true if the message is payable by the caller.

pub fn args(&self) -> &[MessageParamSpec<F>]

Returns the parameters of the message.

pub fn return_type(&self) -> &ReturnTypeSpec<F>

Returns the return type of the message.

pub fn docs(&self) -> &[F::String]

Returns the message documentation.

Trait Implementations

impl<F: Debug + Form> Debug for MessageSpec<F> where
    F::String: Debug,
    F::String: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, F: Form> Deserialize<'de> for MessageSpec<F> where
    F::Type: DeserializeOwned,
    F::String: DeserializeOwned, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl IntoPortable for MessageSpec

type Output = MessageSpec<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<F: PartialEq + Form> PartialEq<MessageSpec<F>> for MessageSpec<F> where
    F::String: PartialEq,
    F::String: PartialEq, 

fn eq(&self, other: &MessageSpec<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MessageSpec<F>) -> bool

This method tests for !=.

impl<F: Form> Serialize for MessageSpec<F> where
    F::Type: Serialize,
    F::String: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<F: Eq + Form> Eq for MessageSpec<F> where
    F::String: Eq,
    F::String: Eq, 

impl<F: Form> StructuralEq for MessageSpec<F>

impl<F: Form> StructuralPartialEq for MessageSpec<F>