Struct ItemImpl

pub struct ItemImpl { /* private fields */ }

An ink! implementation block.

Note

• This can be either an inherent implementation block that implements some constructors, messages or internal functions for the storage struct; OR it can be a trait implementation for the storage struct.
• We try to support all fields that are supported by the underlying syn implementation for syn::ItemImpl even though they are not really required to represent ink!. This is done for consistency with syn.

Implementations

impl ItemImpl

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

Returns a list of cfg attributes if any.

impl ItemImpl

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

Returns all non-ink! specific attributes of the implementation block.

pub fn self_type(&self) -> &Type

Returns the Self type of the implementation block.

pub fn trait_path(&self) -> Option<&Path>

Returns the trait type path if this is a trait implementation block.

Returns None if this is an inherent implementation block.

pub fn trait_ident(&self) -> Option<&Ident>

Returns the trait identifier if this is a trait implementation block.

Returns None if this is an inherent implementation block.

pub fn namespace(&self) -> Option<&Namespace>

Returns the namespace of the implementation block if any has been provided.

pub fn iter_messages(&self) -> IterMessages<'_>

Returns an iterator yielding the ink! messages of the implementation block.

pub fn iter_constructors(&self) -> IterConstructors<'_>

Returns an iterator yielding the ink! messages of the implementation block.

pub fn items(&self) -> &[ImplItem]

Returns a slice over the shared references of the items of the impl.

Trait Implementations

impl Debug for ItemImpl

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

Formats the value using the given formatter.

impl From<ItemImpl> for InkItem

fn from(impl_block: ItemImpl) -> Self

Converts to this type from the input type.

impl PartialEq for ItemImpl

fn eq(&self, other: &ItemImpl) -> 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 ItemImpl

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<ItemImpl> for ItemImpl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item_impl: ItemImpl) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ItemImpl

impl StructuralPartialEq for ItemImpl