Methods

Methods are defined within the context of a struct (or enum) and either refer to the type or mutate it.

The first parameter of a method is always self, which represents the instance of the type the method is being called on.

Declaration

In this example we will take a look at a struct however an enum will work in the same way.

{{#include ../../../code/language/functions/src/lib.sw:struct_definition}}

We start by using the impl (implementation) keyword, followed by the name of our struct, to define a function that belongs to our object i.e. a method.

{{#include ../../../code/language/functions/src/lib.sw:method_impl}}

Usage

To call a method use the dot syntax: <variable name>.<method name>().

{{#include ../../../code/language/functions/src/lib.sw:method_usage}}