Enumerations

Enumerations are sets of symbolic names bound to unique, constant values, which can be compared by identity.

Enum Declaration

Enums are declared using the enum keyword, followed by the name of the enum, the raw type after a colon, and the requirements, which must be enclosed in opening and closing braces.

The raw type must be an integer subtype, e.g. UInt8 or Int128.

Enum cases are declared using the case keyword, followed by the name of the enum case.

Enum cases must be unique. Each enum case has a raw value, the index of the case in all cases.

The raw value of an enum case can be accessed through the rawValue field.

The enum cases can be accessed by using the name as a field on the enum, or by using the enum constructor, which requires providing the raw value as an argument. The enum constructor returns the enum case with the given raw value, if any, or nil if no such case exists.

Enum cases can be compared using the equality operators == and !=.

_29

// Declare an enum named `Color` which has the raw value type `UInt8`,

_29

// and declare three enum cases: `red`, `green`, and `blue`

_29

//

_29

access(all) enum Color: UInt8 {

_29

access(all) case red

_29

access(all) case green

_29

access(all) case blue

_29

}

_29

// Declare a variable which has the enum type `Color` and initialize

_29

// it to the enum case `blue` of the enum

_29

let blue: Color = Color.blue

_29

// Get the raw value of the enum case `blue`.

_29

// As it is the third case, so it has index 2

_29

//

_29

blue.rawValue // is `2`

_29

// Get the `green` enum case of the enum `Color` by using the enum

_29

// constructor and providing the raw value of the enum case `green`, 1,

_29

// as the enum case `green` is the second case, so it has index 1

_29

//

_29

let green: Color? = Color(rawValue: 1) // is `Color.green`

_29

// Get the enum case of the enum `Color` that has the raw value 5.

_29

// As there are only three cases, the maximum raw value / index is 2.

_29

//

_29

let nothing = Color(rawValue: 5) // is `nil`

_29

// Enum cases can be compared

_29

Color.red == Color.red // is `true`

_29

Color(rawValue: 1) == Color.green // is `true`

_29

// Different enum cases are not the same

_29

Color.red != Color.blue // is `true`