Struct Constructor

pub struct Constructor { /* private fields */ }

An ink! constructor definition.

Example

Inherent implementation constructor:

impl MyStorage {
    #[ink(constructor)]
    pub fn new(init_value: i32) -> Self {
        /* contract initialization goes here */
    }
}

Trait implementation constructor:

impl MyTrait for MyStorage {
    #[ink(constructor)]
    fn new(init_value: i32) -> Self {
        // contract initialization goes here
    }
}

Implementations

impl Constructor

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

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

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 output(&self) -> Option<&Type>

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

Trait Implementations

impl Callable for Constructor

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 Constructor

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

Formats the value using the given formatter.

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

fn from(constructor: &'a Constructor) -> Self

Converts to this type from the input type.

impl PartialEq for Constructor

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

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 Constructor

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 Constructor

impl StructuralPartialEq for Constructor