Struct InkTraitMessage

pub struct InkTraitMessage<'a> { /* private fields */ }

A checked ink! message of an ink! trait definition.

Implementations

impl<'a> InkTraitMessage<'a>

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

Returns all non-ink! attributes.

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

Returns a list of cfg attributes if any.

pub fn ink_attrs(&self) -> InkAttribute

Returns all ink! attributes.

pub fn sig(&self) -> &Signature

Returns the original signature of the ink! message.

pub fn receiver(&self) -> Receiver

Returns the self receiver of the ink! trait message.

Returns Ref for &self messages and RefMut for &mut self messages.

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

Returns an iterator over the inputs of the ink! trait message.

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

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

pub fn ident(&self) -> &Ident

Returns the Rust identifier of the ink! message.

pub fn local_id(&self) -> u32

Returns a local ID unique to the ink! trait definition of the ink! trait message.

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 span(&self) -> Span

Returns the span of the ink! message.

pub fn mutates(&self) -> bool

Returns true if the ink! message may mutate the contract storage.

pub fn name(&self) -> Option<String>

Returns the function name override (if any).

pub fn normalized_name(&self) -> String

Returns the “normalized” function name

Note

This returns the name override (if provided), otherwise the identifier is returned.

Trait Implementations

impl<'a> Clone for InkTraitMessage<'a>

fn clone(&self) -> InkTraitMessage<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for InkTraitMessage<'a>

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

Formats the value using the given formatter.

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

fn from(message: &'a InkTraitMessage<'_>) -> Self

Converts to this type from the input type.