pub struct MessageSpec<F: Form = MetaForm> { /* private fields */ }
Expand description
Describes a contract message.
Implementations§
Source§impl<F> MessageSpec<F>
impl<F> MessageSpec<F>
Sourcepub fn from_label(
label: <F as Form>::String,
) -> MessageSpecBuilder<F, Missing<Selector>, Missing<Mutates>, Missing<IsPayable>, Missing<Returns>>
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.
Source§impl<F> MessageSpec<F>where
F: Form,
impl<F> MessageSpec<F>where
F: Form,
Sourcepub fn label(&self) -> &F::String
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.
Sourcepub fn mutates(&self) -> bool
pub fn mutates(&self) -> bool
Returns true if the message is allowed to mutate the contract state.
Sourcepub fn args(&self) -> &[MessageParamSpec<F>]
pub fn args(&self) -> &[MessageParamSpec<F>]
Returns the parameters of the message.
Sourcepub fn return_type(&self) -> &ReturnTypeSpec<F>
pub fn return_type(&self) -> &ReturnTypeSpec<F>
Returns the return type of the message.
pub fn default(&self) -> bool
Trait Implementations§
Source§impl<'de, F: Form> Deserialize<'de> for MessageSpec<F>where
F::Type: DeserializeOwned,
F::String: DeserializeOwned,
impl<'de, F: Form> Deserialize<'de> for MessageSpec<F>where
F::Type: DeserializeOwned,
F::String: DeserializeOwned,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl IntoPortable for MessageSpec
impl IntoPortable for MessageSpec
Source§type Output = MessageSpec<PortableForm>
type Output = MessageSpec<PortableForm>
The portable version of
Self
.Source§fn into_portable(self, registry: &mut Registry) -> Self::Output
fn into_portable(self, registry: &mut Registry) -> Self::Output
Convert
self
to the portable form by using the registry for caching.Source§impl<F: Form + JsonSchema> JsonSchema for MessageSpec<F>
impl<F: Form + JsonSchema> JsonSchema for MessageSpec<F>
Source§fn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
§fn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the
$ref
keyword. Read moreSource§impl<F: Form> Serialize for MessageSpec<F>
impl<F: Form> Serialize for MessageSpec<F>
impl<F: Eq + Form> Eq for MessageSpec<F>where
F::String: Eq,
impl<F: Form> StructuralPartialEq for MessageSpec<F>
Auto Trait Implementations§
impl<F> Freeze for MessageSpec<F>
impl<F> RefUnwindSafe for MessageSpec<F>where
<F as Form>::String: RefUnwindSafe,
<F as Form>::Type: RefUnwindSafe,
impl<F> Send for MessageSpec<F>
impl<F> Sync for MessageSpec<F>
impl<F> Unpin for MessageSpec<F>
impl<F> UnwindSafe for MessageSpec<F>where
<F as Form>::String: UnwindSafe,
<F as Form>::Type: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T
. Read more§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T
.