Struct ink_lang_ir::Message

pub struct Message { /* fields omitted */ }

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

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 is_payable(&self) -> bool

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

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 Eq for Message

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

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

Performs the conversion.

impl PartialEq<Message> for Message

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

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

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

This method tests for !=.

impl StructuralEq for Message

impl StructuralPartialEq for Message

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.

pub fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

pub fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.

impl TryFrom<ImplItemMethod> for Message

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.