Struct ItemMod

pub struct ItemMod { /* private fields */ }

The ink! module.

This is the root of all ink! smart contracts and is defined similarly to a normal Rust module annotated with #[ink::contract( /* optional configuration */ )] attribute.

It contains ink! specific items as well as normal Rust items.

Example

// #[ink::contract] <-- this line belongs to the ink! configuration!
mod my_contract {
    #[ink(storage)]
    pub struct MyStorage {
        // storage fields
    }

    #[ink(event)]
    pub struct MyEvent {
        // event fields
    }

    impl MyStorage {
        #[ink(constructor)]
        pub fn my_constructor() -> Self {
            // constructor initialization
        }

        #[ink(message)]
        pub fn my_message(&self) {
            // message statements
        }
    }
}

Note

This type has been named after syn::ItemMod and inherits all of the fields that are required for inline module definitions.

Developer Note

Structurally the ink! Module mirrors an inline Rust module, for example:

mod rust_module {
    // some Rust item definitions
}

If the capabilities of an inline Rust module change we have to adjust for that.

Implementations

impl ItemMod

pub fn ident(&self) -> &Ident

Returns the identifier of the ink! module.

pub fn storage(&self) -> &Storage

Returns the storage struct definition for this ink! module.

Note

The storage definition is the struct that has been annotated with #[ink(storage)]. This struct is required to be defined in the root of the ink! inline module.

Panics

If zero or multiple #[ink(storage)] annotated structs were found in the ink! module. This can be expected to never happen since upon construction of an ink! module it is asserted that exactly one #[ink(storage)] struct exists.

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

Returns all (ink! and non-ink! specific) item definitions of the ink! inline module.

pub fn impls(&self) -> IterItemImpls<'_>

Returns an iterator yielding all ink! implementation blocks.

Note

An ink! implementation block can be either an inherent impl block directly defined for the contract’s storage struct if it includes at least one #[ink(message)] or #[ink(constructor)] annotation, e.g.:

impl MyStorage {
    #[ink(message)]
    pub fn my_message(&self) {
        // message implementation
    }
}

Also an implementation block can be defined as a trait implementation for the ink! storage struct using the #[ink(impl)] annotation even if none of its interior items have any ink! specific attributes on them, e.g.:

#[ink(impl)]
impl MyStorage {
    fn my_method(&self) -> i32 {
        // method implementation
    }
}

pub fn events(&self) -> IterEvents<'_>

Returns an iterator yielding all event definitions in this ink! module.

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

Returns all non-ink! attributes of the ink! module.

pub fn vis(&self) -> &Visibility

Returns the visibility of the ink! module.

Trait Implementations

impl Debug for ItemMod

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

Formats the value using the given formatter.

impl PartialEq for ItemMod

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

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

We mainly implement this trait for ink! module 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<ItemMod> for ItemMod

type Error = Error

The type returned in the event of a conversion error.

fn try_from(module: ItemMod) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ItemMod

impl StructuralPartialEq for ItemMod