Struct ink_metadata::MessageSpec

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

Describes a contract message.

Implementations

impl<F> MessageSpec<F>

where F: Form, TypeSpec<F>: Default,

pub fn from_label( label: <F as Form>::String, ) -> MessageSpecBuilder<F, Missing<Selector>, Missing<Mutates>, Missing<IsPayable>, Missing<Returns>>

Creates a new message spec builder.

impl<F> MessageSpec<F>

where F: Form,

pub fn label(&self) -> &F::String

Returns the label of the message.

In case of trait provided messages and constructors the prefix by convention in ink! is the label 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.

pub fn default(&self) -> &bool

Trait Implementations

impl<F: Debug + Form> Debug for MessageSpec<F>

where 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: Form + JsonSchema> JsonSchema for MessageSpec<F>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<F: PartialEq + Form> PartialEq for MessageSpec<F>

where 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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,

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