Struct MessageSpec

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

Describes a contract message.

Implementations§

Source§

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

Source

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,

Source

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.

Source

pub fn selector(&self) -> &Selector

Returns the selector hash of the message.

Source

pub fn mutates(&self) -> bool

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

Source

pub fn payable(&self) -> bool

Returns true if the message is payable by the caller.

Source

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

Returns the parameters of the message.

Source

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

Returns the return type of the message.

Source

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

Returns the message documentation.

Source

pub fn default(&self) -> bool

Trait Implementations§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl IntoPortable for MessageSpec

Source§

type Output = MessageSpec<PortableForm>

The portable version of Self.
Source§

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>

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

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

Generates a JSON Schema for this type. Read more
§

fn is_referenceable() -> bool

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

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<F> UnwindSafe for MessageSpec<F>
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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> JsonSchemaMaybe for T
where T: JsonSchema,

§

impl<T> MaybeDebug for T
where T: Debug,