Struct Message

pub struct Message { /* private fields */ }

An ink! message definition.

Example

Inherent implementation message:

impl MyStorage {
    #[ink(message)]
    pub fn my_message(&self, input: i32) -> bool {
        // message implementation goes here
    }
}

Trait implementation message:

impl MyTrait for MyStorage {
    #[ink(message)]
    fn my_message(&mut self, input: bool) -> i32 {
        /* message implementation goes here */
    }
}

Implementations

impl Message

pub fn attrs(&self) -> &[Attribute]

Returns a slice of all non-ink! attributes of the ink! message.

pub fn get_cfg_attrs(&self, span: Span) -> Vec<TokenStream>

Returns a list of cfg attributes if any.

pub fn get_cfg_syn_attrs(&self) -> Vec<Attribute>

Returns a list of cfg attributes as syn::Attribute if any.

pub fn receiver(&self) -> Receiver

Returns the self receiver of the ink! message.

pub fn output(&self) -> Option<&Type>

Returns the return type of the ink! message if any.

pub fn wrapped_output(&self) -> Type

Returns the return type of the message, but wrapped within a Result.

This is used to to allow callers to handle certain types of errors which are not exposed by messages.

pub fn local_id(&self) -> u32

Returns a local ID unique to the ink! message with respect to its implementation block.

Note

It is a compile error if two ink! trait messages share the same local ID. Although the above scenario is very unlikely since the local ID is computed solely by the identifier of the ink! message.

pub fn try_ident(&self) -> Ident

Returns the identifier of the message with an additional try_ prefix attached.

Trait Implementations

impl Callable for Message

fn kind(&self) -> CallableKind

Returns the kind of the ink! callable.

fn ident(&self) -> &Ident

Returns the identifier of the ink! callable.

fn user_provided_selector(&self) -> Option<&Selector>

Returns the selector of the ink! callable if any has been manually set.

fn has_wildcard_selector(&self) -> bool

Returns true if the ink! callable is flagged as a wildcard selector.

fn has_wildcard_complement_selector(&self) -> bool

Returns true if the ink! callable is flagged as a wildcard complement selector.

fn is_payable(&self) -> bool

Returns true if the ink! callable is flagged as payable.

fn is_default(&self) -> bool

Returns true if the ink! callable is flagged as default.

fn visibility(&self) -> Visibility

Returns the visibility of the ink! callable.

fn inputs(&self) -> InputsIter<'_>

Returns an iterator yielding all input parameters of the ink! callable.

fn inputs_span(&self) -> Span

Returns the span of the inputs of the ink! callable.

fn statements(&self) -> &[Stmt]

Returns a slice over shared references to the statements of the callable.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'a> From<&'a Message> for InputsIter<'a>

fn from(message: &'a Message) -> Self

Converts to this type from the input type.

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl ToTokens for Message

fn to_tokens(&self, tokens: &mut TokenStream)

We mainly implement this trait for this ink! type to have a derived Spanned implementation for it.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl TryFrom<ImplItemFn> for Message

type Error = Error

The type returned in the event of a conversion error.

fn try_from(method_item: ImplItemFn) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Message

impl StructuralPartialEq for Message