Skip to main content
Version: Next

Composite Types

Composite types allow composing simpler types into more complex types, i.e., they allow the composition of multiple values into one. Composite types have a name and consist of zero or more named fields, and zero or more functions that operate on the data. Each field may have a different type.

Composite types can only be declared within a contract and nowhere else.

There are two kinds of composite types. The kinds differ in their usage and the behaviour when a value is used as the initial value for a constant or variable, when the value is assigned to a variable, when the value is passed as an argument to a function, and when the value is returned from a function:

  • Structures are copied, they are value types.

    Structures are useful when copies with independent state are desired.

  • Resources are moved, they are linear types and must be used exactly once.

    Resources are useful when it is desired to model ownership (a value exists exactly in one location and it should not be lost).

    Certain constructs in a blockchain represent assets of real, tangible value, as much as a house or car or bank account. We have to worry about literal loss and theft, perhaps even on the scale of millions of dollars.

    Structures are not an ideal way to represent this ownership because they are copied. This would mean that there could be a risk of having multiple copies of certain assets floating around, which breaks the scarcity requirements needed for these assets to have real value.

    A structure is much more useful for representing information that can be grouped together in a logical way, but doesn't have value or a need to be able to be owned or transferred.

    A structure could for example be used to contain the information associated with a division of a company, but a resource would be used to represent the assets that have been allocated to that organization for spending.

Nesting of resources is only allowed within other resource types, or in data structures like arrays and dictionaries, but not in structures, as that would allow resources to be copied.

Composite Type Declaration and Creation

Structures are declared using the struct keyword and resources are declared using the resource keyword. The keyword is followed by the name.


_10
pub struct SomeStruct {
_10
// ...
_10
}
_10
_10
pub resource SomeResource {
_10
// ...
_10
}

Structures and resources are types.

Structures are created (instantiated) by calling the type like a function.


_10
// instantiate a new struct object and assign it to a constant
_10
let a = SomeStruct()

The constructor function may require parameters if the initializer of the composite type requires them.

Composite types can only be declared within contracts and not locally in functions.

Resource must be created (instantiated) by using the create keyword and calling the type like a function.

Resources can only be created in functions and types that are declared in the same contract in which the resource is declared.


_10
// instantiate a new resource object and assign it to a constant
_10
let b <- create SomeResource()

Composite Type Fields

Fields are declared like variables and constants. However, the initial values for fields are set in the initializer, not in the field declaration. All fields must be initialized in the initializer, exactly once.

Having to provide initial values in the initializer might seem restrictive, but this ensures that all fields are always initialized in one location, the initializer, and the initialization order is clear.

The initialization of all fields is checked statically and it is invalid to not initialize all fields in the initializer. Also, it is statically checked that a field is definitely initialized before it is used.

The initializer's main purpose is to initialize fields, though it may also contain other code. Just like a function, it may declare parameters and may contain arbitrary code. However, it has no return type, i.e., it is always Void.

The initializer is declared using the init keyword.

The initializer always follows any fields.

There are three kinds of fields:

  • Constant fields are also stored in the composite value, but after they have been initialized with a value they cannot have new values assigned to them afterwards. A constant field must be initialized exactly once.

    Constant fields are declared using the let keyword.

  • Variable fields are stored in the composite value and can have new values assigned to them.

    Variable fields are declared using the var keyword.

Field KindAssignableKeyword
Variable fieldYesvar
Constant fieldNolet

In initializers, the special constant self refers to the composite value that is to be initialized.

If a composite type is to be stored, all its field types must be storable. Non-storable types are:

Fields can be read (if they are constant or variable) and set (if they are variable), using the access syntax: the composite value is followed by a dot (.) and the name of the field.


_19
// Declare a structure named `Token`, which has a constant field
_19
// named `id` and a variable field named `balance`.
_19
//
_19
// Both fields are initialized through the initializer.
_19
//
_19
// The public access modifier `pub` is used in this example to allow
_19
// the fields to be read in outer scopes. Fields can also be declared
_19
// private so they cannot be accessed in outer scopes.
_19
// Access control will be explained in a later section.
_19
//
_19
pub struct Token {
_19
pub let id: Int
_19
pub var balance: Int
_19
_19
init(id: Int, balance: Int) {
_19
self.id = id
_19
self.balance = balance
_19
}
_19
}

Note that it is invalid to provide the initial value for a field in the field declaration.


_10
pub struct StructureWithConstantField {
_10
// Invalid: It is invalid to provide an initial value in the field declaration.
_10
// The field must be initialized by setting the initial value in the initializer.
_10
//
_10
pub let id: Int = 1
_10
}

The field access syntax must be used to access fields – fields are not available as variables.


_10
pub struct Token {
_10
pub let id: Int
_10
_10
init(initialID: Int) {
_10
// Invalid: There is no variable with the name `id` available.
_10
// The field `id` must be initialized by setting `self.id`.
_10
//
_10
id = initialID
_10
}
_10
}

The initializer is not automatically derived from the fields, it must be explicitly declared.


_10
pub struct Token {
_10
pub let id: Int
_10
_10
// Invalid: Missing initializer initializing field `id`.
_10
}

A composite value can be created by calling the constructor and providing the field values as arguments.

The value's fields can be accessed on the object after it is created.


_11
let token = Token(id: 42, balance: 1_000_00)
_11
_11
token.id // is `42`
_11
token.balance // is `1_000_000`
_11
_11
token.balance = 1
_11
// `token.balance` is `1`
_11
_11
// Invalid: assignment to constant field
_11
//
_11
token.id = 23

Initializers do not support overloading.

Initializers can also be declared with the view keyword, to indicate that they do not perform any mutating operations, and to allow them to be called from within other view functions. In an initializer, writes to self are considered view (unlike within other composite functions), as the value being constructed here is by definition local to the context calling the initializer.


_10
pub struct Token {
_10
pub let id: Int
_10
pub var balance: Int
_10
_10
view init(id: Int, balance: Int) {
_10
self.id = id
_10
self.balance = balance
_10
}
_10
}

Composite Type Functions

Composite types may contain functions. Just like in the initializer, the special constant self refers to the composite value that the function is called on.


_25
// Declare a structure named "Rectangle", which represents a rectangle
_25
// and has variable fields for the width and height.
_25
//
_25
pub struct Rectangle {
_25
pub var width: Int
_25
pub var height: Int
_25
_25
init(width: Int, height: Int) {
_25
self.width = width
_25
self.height = height
_25
}
_25
_25
// Declare a function named "scale", which scales
_25
// the rectangle by the given factor.
_25
//
_25
pub fun scale(factor: Int) {
_25
self.width = self.width * factor
_25
self.height = self.height * factor
_25
}
_25
}
_25
_25
let rectangle = Rectangle(width: 2, height: 3)
_25
rectangle.scale(factor: 4)
_25
// `rectangle.width` is `8`
_25
// `rectangle.height` is `12`

Functions do not support overloading.

Composite Type Subtyping

Two composite types are compatible if and only if they refer to the same declaration by name, i.e., nominal typing applies instead of structural typing.

Even if two composite types declare the same fields and functions, the types are only compatible if their names match.


_28
// Declare a structure named `A` which has a function `test`
_28
// which has type `fun(): Void`.
_28
//
_28
struct A {
_28
fun test() {}
_28
}
_28
_28
// Declare a structure named `B` which has a function `test`
_28
// which has type `fun(): Void`.
_28
//
_28
struct B {
_28
fun test() {}
_28
}
_28
_28
// Declare a variable named which accepts values of type `A`.
_28
//
_28
var something: A = A()
_28
_28
// Invalid: Assign a value of type `B` to the variable.
_28
// Even though types `A` and `B` have the same declarations,
_28
// a function with the same name and type, the types' names differ,
_28
// so they are not compatible.
_28
//
_28
something = B()
_28
_28
// Valid: Reassign a new value of type `A`.
_28
//
_28
something = A()

Composite Type Behaviour

Structures

Structures are copied when used as an initial value for constant or variable, when assigned to a different variable, when passed as an argument to a function, and when returned from a function.

Accessing a field or calling a function of a structure does not copy it.


_27
// Declare a structure named `SomeStruct`, with a variable integer field.
_27
//
_27
pub struct SomeStruct {
_27
pub var value: Int
_27
_27
init(value: Int) {
_27
self.value = value
_27
}
_27
_27
fun increment() {
_27
self.value = self.value + 1
_27
}
_27
}
_27
_27
// Declare a constant with value of structure type `SomeStruct`.
_27
//
_27
let a = SomeStruct(value: 0)
_27
_27
// *Copy* the structure value into a new constant.
_27
//
_27
let b = a
_27
_27
b.value = 1
_27
// NOTE: `b.value` is 1, `a.value` is *`0`*
_27
_27
b.increment()
_27
// `b.value` is 2, `a.value` is `0`

Accessing Fields and Functions of Composite Types Using Optional Chaining

If a composite type with fields and functions is wrapped in an optional, optional chaining can be used to get those values or call the function without having to get the value of the optional first.

Optional chaining is used by adding a ? before the . access operator for fields or functions of an optional composite type.

When getting a field value or calling a function with a return value, the access returns the value as an optional. If the object doesn't exist, the value will always be nil

When calling a function on an optional like this, if the object doesn't exist, nothing will happen and the execution will continue.

It is still invalid to access an undeclared field of an optional composite type.


_47
// Declare a struct with a field and method.
_47
pub struct Value {
_47
pub var number: Int
_47
_47
init() {
_47
self.number = 2
_47
}
_47
_47
pub fun set(new: Int) {
_47
self.number = new
_47
}
_47
_47
pub fun setAndReturn(new: Int): Int {
_47
self.number = new
_47
return new
_47
}
_47
}
_47
_47
// Create a new instance of the struct as an optional
_47
let value: Value? = Value()
_47
// Create another optional with the same type, but nil
_47
let noValue: Value? = nil
_47
_47
// Access the `number` field using optional chaining
_47
let twoOpt = value?.number
_47
// Because `value` is an optional, `twoOpt` has type `Int?`
_47
let two = twoOpt ?? 0
_47
// `two` is `2`
_47
_47
// Try to access the `number` field of `noValue`, which has type `Value?`.
_47
// This still returns an `Int?`
_47
let nilValue = noValue?.number
_47
// This time, since `noValue` is `nil`, `nilValue` will also be `nil`
_47
_47
// Try to call the `set` function of `value`.
_47
// The function call is performed, as `value` is not nil
_47
value?.set(new: 4)
_47
_47
// Try to call the `set` function of `noValue`.
_47
// The function call is *not* performed, as `noValue` is nil
_47
noValue?.set(new: 4)
_47
_47
// Call the `setAndReturn` function, which returns an `Int`.
_47
// Because `value` is an optional, the return value is type `Int?`
_47
let sixOpt = value?.setAndReturn(new: 6)
_47
let six = sixOpt ?? 0
_47
// `six` is `6`

This is also possible by using the force-unwrap operator (!).

Forced-Optional chaining is used by adding a ! before the . access operator for fields or functions of an optional composite type.

When getting a field value or calling a function with a return value, the access returns the value. If the object doesn't exist, the execution will panic and revert.

It is still invalid to access an undeclared field of an optional composite type.


_46
// Declare a struct with a field and method.
_46
pub struct Value {
_46
pub var number: Int
_46
_46
init() {
_46
self.number = 2
_46
}
_46
_46
pub fun set(new: Int) {
_46
self.number = new
_46
}
_46
_46
pub fun setAndReturn(new: Int): Int {
_46
self.number = new
_46
return new
_46
}
_46
}
_46
_46
// Create a new instance of the struct as an optional
_46
let value: Value? = Value()
_46
// Create another optional with the same type, but nil
_46
let noValue: Value? = nil
_46
_46
// Access the `number` field using force-optional chaining
_46
let two = value!.number
_46
// `two` is `2`
_46
_46
// Try to access the `number` field of `noValue`, which has type `Value?`
_46
// Run-time error: This time, since `noValue` is `nil`,
_46
// the program execution will revert
_46
let number = noValue!.number
_46
_46
// Call the `set` function of the struct
_46
_46
// This succeeds and sets the value to 4
_46
value!.set(new: 4)
_46
_46
// Run-time error: Since `noValue` is nil, the value is not set
_46
// and the program execution reverts.
_46
noValue!.set(new: 4)
_46
_46
// Call the `setAndReturn` function, which returns an `Int`
_46
// Because we use force-unwrap before calling the function,
_46
// the return value is type `Int`
_46
let six = value!.setAndReturn(new: 6)
_46
// `six` is `6`

Resources

Resources are explained in detail in the following page.

Unbound References / Nulls

There is no support for null.

Inheritance and Abstract Types

There is no support for inheritance. Inheritance is a feature common in other programming languages, that allows including the fields and functions of one type in another type.

Instead, follow the "composition over inheritance" principle, the idea of composing functionality from multiple individual parts, rather than building an inheritance tree.

Furthermore, there is also no support for abstract types. An abstract type is a feature common in other programming languages, that prevents creating values of the type and only allows the creation of values of a subtype. In addition, abstract types may declare functions, but omit the implementation of them and instead require subtypes to implement them.

Instead, consider using interfaces.