Values and Types

Values are objects, like for example booleans, integers, or arrays. Values are typed.

Booleans

The two boolean values true and false have the type Bool.

Numeric Literals

Numbers can be written in various bases. Numbers are assumed to be decimal by default. Non-decimal literals have a specific prefix.

Numeral system	Prefix	Characters
Decimal	None	one or more numbers (`0` to `9`)
Binary	`0b`	one or more zeros or ones (`0` or `1`)
Octal	`0o`	one or more numbers in the range `0` to `7`
Hexadecimal	`0x`	one or more numbers, or characters `a` to `f`, lowercase or uppercase

// A decimal number
//
1234567890  // is `1234567890`
// A binary number
//
0b101010  // is `42`
// An octal number
//
0o12345670  // is `2739128`
// A hexadecimal number
//
0x1234567890ABCabc  // is `1311768467294898876`
// Invalid: unsupported prefix 0z
//
0z0
// A decimal number with leading zeros. Not an octal number!
00123 // is `123`
// A binary number with several trailing zeros.
0b001000  // is `8`

Decimal numbers may contain underscores (_) to logically separate components.

let largeNumber = 1_000_000
// Invalid: Value is not a number literal, but a variable.
let notNumber = _123

Underscores are allowed for all numeral systems.

let binaryNumber = 0b10_11_01

Integers

Integers are numbers without a fractional part. They are either signed (positive, zero, or negative) or unsigned (positive or zero).

Signed integer types which check for overflow and underflow have an Int prefix and can represent values in the following ranges:

Int8: -2^7 through 2^7 − 1 (-128 through 127)
Int16: -2^15 through 2^15 − 1 (-32768 through 32767)
Int32: -2^31 through 2^31 − 1 (-2147483648 through 2147483647)
Int64: -2^63 through 2^63 − 1 (-9223372036854775808 through 9223372036854775807)
Int128: -2^127 through 2^127 − 1
Int256: -2^255 through 2^255 − 1

Unsigned integer types which check for overflow and underflow have a UInt prefix and can represent values in the following ranges:

UInt8: 0 through 2^8 − 1 (255)
UInt16: 0 through 2^16 − 1 (65535)
UInt32: 0 through 2^32 − 1 (4294967295)
UInt64: 0 through 2^64 − 1 (18446744073709551615)
UInt128: 0 through 2^128 − 1
UInt256: 0 through 2^256 − 1

Unsigned integer types which do not check for overflow and underflow, i.e. wrap around, have the Word prefix and can represent values in the following ranges:

Word8: 0 through 2^8 − 1 (255)
Word16: 0 through 2^16 − 1 (65535)
Word32: 0 through 2^32 − 1 (4294967295)
Word64: 0 through 2^64 − 1 (18446744073709551615)

The types are independent types, i.e. not subtypes of each other.

See the section about arithmetic operators for further information about the behavior of the different integer types.

// Declare a constant that has type `UInt8` and the value 10.
let smallNumber: UInt8 = 10

// Invalid: negative literal cannot be used as an unsigned integer
//
let invalidNumber: UInt8 = -10

In addition, the arbitrary precision integer type Int is provided.

let veryLargeNumber: Int = 10000000000000000000000000000000

Integer literals are inferred to have type Int, or if the literal occurs in a position that expects an explicit type, e.g. in a variable declaration with an explicit type annotation.

let someNumber = 123
// `someNumber` has type `Int`

Negative integers are encoded in two's complement representation.

Integer types are not converted automatically. Types must be explicitly converted, which can be done by calling the constructor of the type with the integer type.

let x: Int8 = 1
let y: Int16 = 2
// Invalid: the types of the operands, `Int8` and `Int16` are incompatible.
let z = x + y
// Explicitly convert `x` from `Int8` to `Int16`.
let a = Int16(x) + y
// `a` has type `Int16`
// Invalid: The integer literal is expected to be of type `Int8`,
// but the large integer literal does not fit in the range of `Int8`.
//
let b = x + 1000000000000000000000000

Integer Functions

Integers have multiple built-in functions you can use.

_10fun toString(): String

Returns the string representation of the integer.

_10let answer = 42 _10 _10answer.toString() // is "42"
_10fun toBigEndianBytes(): [UInt8]

Returns the byte array representation ([UInt8]) in big-endian order of the integer.

_10let largeNumber = 1234567890 _10 _10largeNumber.toBigEndianBytes() // is `[73, 150, 2, 210]`

All integer types support the following functions:

_10fun T.fromString(_ input: String): T?

Attempts to parse an integer value from a base-10 encoded string, returning nil if the string is invalid.

For a given integer n of type T, T.fromString(n.toString()) is equivalent to wrapping n up in an optional.

Strings are invalid if:
- they contain non-digit characters
- they don't fit in the target type
For signed integer types like Int64, and Int, the string may optionally begin with + or - sign prefix.

For unsigned integer types like Word64, UInt64, and UInt, sign prefices are not allowed.

Examples:

_10let fortyTwo: Int64? = Int64.fromString("42") // ok _10 _10let twenty: UInt? = UInt.fromString("20") // ok _10 _10let nilWord: Word8? = Word8.fromString("1024") // nil, out of bounds _10 _10let negTwenty: Int? = Int.fromString("-20") // ok

Fixed-Point Numbers

🚧 Status: Currently only the 64-bit wide Fix64 and UFix64 types are available. More fixed-point number types will be added in a future release.

Fixed-point numbers are useful for representing fractional values. They have a fixed number of digits after decimal point.

They are essentially integers which are scaled by a factor. For example, the value 1.23 can be represented as 1230 with a scaling factor of 1/1000. The scaling factor is the same for all values of the same type and stays the same during calculations.

Fixed-point numbers in Cadence have a scaling factor with a power of 10, instead of a power of 2, i.e. they are decimal, not binary.

Signed fixed-point number types have the prefix Fix, have the following factors, and can represent values in the following ranges:

Fix64: Factor 1/100,000,000; -92233720368.54775808 through 92233720368.54775807

Unsigned fixed-point number types have the prefix UFix, have the following factors, and can represent values in the following ranges:

UFix64: Factor 1/100,000,000; 0.0 through 184467440737.09551615

Fixed-Point Number Functions

Fixed-Point numbers have multiple built-in functions you can use.

_10fun toString(): String

Returns the string representation of the fixed-point number.

_10let fix = 1.23 _10 _10fix.toString() // is "1.23000000"
_10fun toBigEndianBytes(): [UInt8]

Returns the byte array representation ([UInt8]) in big-endian order of the fixed-point number.

_10let fix = 1.23 _10 _10fix.toBigEndianBytes() // is `[0, 0, 0, 0, 7, 84, 212, 192]`

All fixed-point types support the following functions:

_10fun T.fromString(_ input: String): T?

Attempts to parse a fixed-point value from a base-10 encoded string, returning nil if the string is invalid.

For a given fixed-point numeral n of type T, T.fromString(n.toString()) is equivalent to wrapping n up in an optional.

Strings are invalid if:
- they contain non-digit characters.
- they don't fit in the target type.
- they're missing a decimal or fractional component. For example, both "0." and ".1" are invalid strings, but "0.1" is accepted.
For signed types like Fix64, the string may optionally begin with + or - sign prefix.

For unsigned types like UFix64, sign prefices are not allowed.

Examples:

_11let nil1: UFix64? = UFix64.fromString("0.") // nil, fractional part is required _11 _11let nil2: UFix64? = UFix64.fromString(".1") // nil, decimal part is required _11 _11let smol: UFix64? = UFix64.fromString("0.1") // ok _11 _11let smolString: String = "-0.1" _11 _11let nil3: UFix64? = UFix64.fromString(smolString) // nil, unsigned types don't allow a sign prefix _11 _11let smolFix64: Fix64? = Fix64.fromString(smolString) // ok

Minimum and maximum values

The minimum and maximum values for all integer and fixed-point number types are available through the fields min and max.

For example:

let max = UInt8.max
// `max` is 255, the maximum value of the type `UInt8`

let max = UFix64.max
// `max` is 184467440737.09551615, the maximum value of the type `UFix64`

Saturation Arithmetic

Integers and fixed-point numbers support saturation arithmetic: Arithmetic operations, such as addition or multiplications, are saturating at the numeric bounds instead of overflowing.

If the result of an operation is greater than the maximum value of the operands' type, the maximum is returned. If the result is lower than the minimum of the operands' type, the minimum is returned.

Saturating addition, subtraction, multiplication, and division are provided as functions with the prefix saturating:

Int8, Int16, Int32, Int64, Int128, Int256, Fix64:
- saturatingAdd
- saturatingSubtract
- saturatingMultiply
- saturatingDivide
Int:
- none
UInt8, UInt16, UInt32, UInt64, UInt128, UInt256, UFix64:
- saturatingAdd
- saturatingSubtract
- saturatingMultiply
UInt:
- saturatingSubtract

let a: UInt8 = 200
let b: UInt8 = 100
let result = a.saturatingAdd(b)
// `result` is 255, the maximum value of the type `UInt8`

Floating-Point Numbers

There is no support for floating point numbers.

Smart Contracts are not intended to work with values with error margins and therefore floating point arithmetic is not appropriate here.

Instead, consider using fixed point numbers.

Addresses

The type Address represents an address. Addresses are unsigned integers with a size of 64 bits (8 bytes). Hexadecimal integer literals can be used to create address values.

// Declare a constant that has type `Address`.
//
let someAddress: Address = 0x436164656E636521
// Invalid: Initial value is not compatible with type `Address`,
// it is not a number.
//
let notAnAddress: Address = ""
// Invalid: Initial value is not compatible with type `Address`.
// The integer literal is valid, however, it is larger than 64 bits.
//
let alsoNotAnAddress: Address = 0x436164656E63652146757265766572

Integer literals are not inferred to be an address.

// Declare a number. Even though it happens to be a valid address,
// it is not inferred as it.
//
let aNumber = 0x436164656E636521
// `aNumber` has type `Int`

Address can also be created using a byte array.

// Declare an address with hex representation as 0x436164656E636521.
let someAddress: Address = Address.fromBytes([67, 97, 100, 101, 110, 99, 101, 33])
// Invalid: Provided value is not compatible with type `Address`. The function panics.
let invalidAddress: Address = Address.fromBytes([12, 34, 56, 11, 22, 33, 44, 55, 66, 77, 88, 99, 111])

Address Functions

Addresses have multiple built-in functions you can use.

_10fun toString(): String

Returns the string representation of the address. The result has a 0x prefix and is zero-padded.

_10let someAddress: Address = 0x436164656E636521 _10someAddress.toString() // is "0x436164656E636521" _10 _10let shortAddress: Address = 0x1 _10shortAddress.toString() // is "0x0000000000000001"
_10fun toBytes(): [UInt8]

Returns the byte array representation ([UInt8]) of the address.

_10let someAddress: Address = 0x436164656E636521 _10 _10someAddress.toBytes() // is `[67, 97, 100, 101, 110, 99, 101, 33]`

AnyStruct and AnyResource

AnyStruct is the top type of all non-resource types, i.e., all non-resource types are a subtype of it.

AnyResource is the top type of all resource types.

// Declare a variable that has the type `AnyStruct`.
// Any non-resource typed value can be assigned to it, for example an integer,
// but not resource-typed values.
//
var someStruct: AnyStruct = 1
// Assign a value with a different non-resource type, `Bool`.
someStruct = true
// Declare a structure named `TestStruct`, create an instance of it,
// and assign it to the `AnyStruct`-typed variable
//
struct TestStruct {}
let testStruct = TestStruct()
someStruct = testStruct
// Declare a resource named `TestResource`
resource TestResource {}
// Declare a variable that has the type `AnyResource`.
// Any resource-typed value can be assigned to it,
// but not non-resource typed values.
//
var someResource: @AnyResource <- create TestResource()
// Invalid: Resource-typed values can not be assigned
// to `AnyStruct`-typed variables
//
someStruct <- create TestResource()
// Invalid: Non-resource typed values can not be assigned
// to `AnyResource`-typed variables
//
someResource = 1

However, using AnyStruct and AnyResource does not opt-out of type checking. It is invalid to access fields and call functions on these types, as they have no fields and functions.

// Declare a variable that has the type `AnyStruct`.
// The initial value is an integer,
// but the variable still has the explicit type `AnyStruct`.
//
let a: AnyStruct = 1
// Invalid: Operator cannot be used for an `AnyStruct` value (`a`, left-hand side)
// and an `Int` value (`2`, right-hand side).
//
a + 2

AnyStruct and AnyResource may be used like other types, for example, they may be the element type of arrays or be the element type of an optional type.

// Declare a variable that has the type `[AnyStruct]`,
// i.e. an array of elements of any non-resource type.
//
let anyValues: [AnyStruct] = [1, "2", true]
// Declare a variable that has the type `AnyStruct?`,
// i.e. an optional type of any non-resource type.
//
var maybeSomething: AnyStruct? = 42
maybeSomething = "twenty-four"
maybeSomething = nil

AnyStruct is also the super-type of all non-resource optional types, and AnyResource is the super-type of all resource optional types.

let maybeInt: Int? = 1
let anything: AnyStruct = maybeInt

Conditional downcasting allows coercing a value which has the type AnyStruct or AnyResource back to its original type.

Optionals

Optionals are values which can represent the absence of a value. Optionals have two cases: either there is a value, or there is nothing.

An optional type is declared using the ? suffix for another type. For example, Int is a non-optional integer, and Int? is an optional integer, i.e. either nothing, or an integer.

The value representing nothing is nil.

// Declare a constant which has an optional integer type,
// with nil as its initial value.
//
let a: Int? = nil
// Declare a constant which has an optional integer type,
// with 42 as its initial value.
//
let b: Int? = 42
// Invalid: `b` has type `Int?`, which does not support arithmetic.
b + 23
// Invalid: Declare a constant with a non-optional integer type `Int`,
// but the initial value is `nil`, which in this context has type `Int?`.
//
let x: Int = nil

Optionals can be created for any value, not just for literals.

// Declare a constant which has a non-optional integer type,
// with 1 as its initial value.
//
let x = 1
// Declare a constant which has an optional integer type.
// An optional with the value of `x` is created.
//
let y: Int? = x
// Declare a variable which has an optional any type, i.e. the variable
// may be `nil`, or any other value.
// An optional with the value of `x` is created.
//
var z: AnyStruct? = x

A non-optional type is a subtype of its optional type.

var a: Int? = nil
let b = 2
a = b
// `a` is `2`

Optional types may be contained in other types, for example arrays or even optionals.

// Declare a constant which has an array type of optional integers.
let xs: [Int?] = [1, nil, 2, nil]
// Declare a constant which has a double optional type.
//
let doubleOptional: Int?? = nil

See the optional operators section for information on how to work with optionals.

Never

Never is the bottom type, i.e., it is a subtype of all types. There is no value that has type Never. Never can be used as the return type for functions that never return normally. For example, it is the return type of the function panic.

// Declare a function named `crashAndBurn` which will never return,
// because it calls the function named `panic`, which never returns.
//
fun crashAndBurn(): Never {
    panic("An unrecoverable error occurred")
}
// Invalid: Declare a constant with a `Never` type, but the initial value is an integer.
//
let x: Never = 1
// Invalid: Declare a function which returns an invalid return value `nil`,
// which is not a value of type `Never`.
//
fun returnNever(): Never {
    return nil
}

Strings and Characters

Strings are collections of characters. Strings have the type String, and characters have the type Character. Strings can be used to work with text in a Unicode-compliant way. Strings are immutable.

String and character literals are enclosed in double quotation marks (").

let someString = "Hello, world!"

String literals may contain escape sequences. An escape sequence starts with a backslash (\):

\0: Null character
\\: Backslash
\t: Horizontal tab
\n: Line feed
\r: Carriage return
\": Double quotation mark
\': Single quotation mark
\u: A Unicode scalar value, written as \u{x}, where x is a 1–8 digit hexadecimal number which needs to be a valid Unicode scalar value, i.e., in the range 0 to 0xD7FF and 0xE000 to 0x10FFFF inclusive

// Declare a constant which contains two lines of text
// (separated by the line feed character `\n`), and ends
// with a thumbs up emoji, which has code point U+1F44D (0x1F44D).
//
let thumbsUpText =
    "This is the first line.\nThis is the second line with an emoji: \u{1F44D}"

The type Character represents a single, human-readable character. Characters are extended grapheme clusters, which consist of one or more Unicode scalars.

For example, the single character ü can be represented in several ways in Unicode. First, it can be represented by a single Unicode scalar value ü ("LATIN SMALL LETTER U WITH DIAERESIS", code point U+00FC). Second, the same single character can be represented by two Unicode scalar values: u ("LATIN SMALL LETTER U", code point U+0075), and "COMBINING DIAERESIS" (code point U+0308). The combining Unicode scalar value is applied to the scalar before it, which turns a u into a ü.

Still, both variants represent the same human-readable character ü.

let singleScalar: Character = "\u{FC}"
// `singleScalar` is `ü`
let twoScalars: Character = "\u{75}\u{308}"
// `twoScalars` is `ü`

Another example where multiple Unicode scalar values are rendered as a single, human-readable character is a flag emoji. These emojis consist of two "REGIONAL INDICATOR SYMBOL LETTER" Unicode scalar values.

// Declare a constant for a string with a single character, the emoji
// for the Canadian flag, which consists of two Unicode scalar values:
// - REGIONAL INDICATOR SYMBOL LETTER C (U+1F1E8)
// - REGIONAL INDICATOR SYMBOL LETTER A (U+1F1E6)
//
let canadianFlag: Character = "\u{1F1E8}\u{1F1E6}"
// `canadianFlag` is `🇨🇦`

String Fields and Functions

Strings have multiple built-in functions you can use:

_10let length: Int

Returns the number of characters in the string as an integer.

_10let example = "hello" _10 _10// Find the number of elements of the string. _10let length = example.length _10// `length` is `5`
_10let utf8: [UInt8]

The byte array of the UTF-8 encoding

_10let flowers = "Flowers \u{1F490}" _10let bytes = flowers.utf8 _10// `bytes` is `[70, 108, 111, 119, 101, 114, 115, 32, 240, 159, 146, 144]`
_10fun concat(_ other: String): String

Concatenates the string other to the end of the original string, but does not modify the original string. This function creates a new string whose length is the sum of the lengths of the string the function is called on and the string given as a parameter.

_10let example = "hello" _10let new = "world" _10 _10// Concatenate the new string onto the example string and return the new string. _10let helloWorld = example.concat(new) _10// `helloWorld` is now `"helloworld"`
_10fun slice(from: Int, upTo: Int): String

Returns a string slice of the characters in the given string from start index from up to, but not including, the end index upTo. This function creates a new string whose length is upTo - from. It does not modify the original string. If either of the parameters are out of the bounds of the string, or the indices are invalid (from > upTo), then the function will fail.

_11let example = "helloworld" _11 _11// Create a new slice of part of the original string. _11let slice = example.slice(from: 3, upTo: 6) _11// `slice` is now `"low"` _11 _11// Run-time error: Out of bounds index, the program aborts. _11let outOfBounds = example.slice(from: 2, upTo: 10) _11 _11// Run-time error: Invalid indices, the program aborts. _11let invalidIndices = example.slice(from: 2, upTo: 1)
_10fun decodeHex(): [UInt8]

Returns an array containing the bytes represented by the given hexadecimal string.

The given string must only contain hexadecimal characters and must have an even length. If the string is malformed, the program aborts

_10let example = "436164656e636521" _10 _10example.decodeHex() // is `[67, 97, 100, 101, 110, 99, 101, 33]`
_10fun toLower(): String

Returns a string where all upper case letters are replaced with lowercase characters

_10let example = "Flowers" _10 _10example.toLower() // is `flowers`

The String type also provides the following functions:

_10fun String.encodeHex(_ data: [UInt8]): String

Returns a hexadecimal string for the given byte array

_10let data = [1 as UInt8, 2, 3, 0xCA, 0xDE] _10 _10String.encodeHex(data) // is `"010203cade"`

Strings are also indexable, returning a Character value.

let str = "abc"
let c = str[0] // is the Character "a"

_10fun String.fromUTF8(_ input: [UInt8]): String?

Attempts to convert a UTF-8 encoded byte array into a String. This function returns nil if the byte array contains invalid UTF-8, such as incomplete codepoint sequences or undefined graphemes.

For a given string s, String.fromUTF8(s.utf8) is equivalent to wrapping s up in an optional.

Character Fields and Functions

Character values can be converted into String values using the toString function:

_10fun toString(): String`

Returns the string representation of the character.

_10let c: Character = "x" _10 _10c.toString() // is "x"
_10fun String.fromCharacters(_ characters: [Character]): String

Builds a new String value from an array of Characters. Because Strings are immutable, this operation makes a copy of the input array.

_10let rawUwU: [Character] = ["U", "w", "U"] _10let uwu: String = String.fromCharacters(rawUwU) // "UwU"

Arrays

Arrays are mutable, ordered collections of values. Arrays may contain a value multiple times. Array literals start with an opening square bracket [ and end with a closing square bracket ].

// An empty array
//
[]
// An array with integers
//
[1, 2, 3]

Array Types

Arrays either have a fixed size or are variably sized, i.e., elements can be added and removed.

Fixed-size array types have the form [T; N], where T is the element type, and N is the size of the array. N has to be statically known, meaning that it needs to be an integer literal. For example, a fixed-size array of 3 Int8 elements has the type [Int8; 3].

Variable-size array types have the form [T], where T is the element type. For example, the type [Int16] specifies a variable-size array of elements that have type Int16.

All values in an array must have a type which is a subtype of the array's element type (T).

It is important to understand that arrays are value types and are only ever copied when used as an initial value for a constant or variable, when assigning to a variable, when used as function argument, or when returned from a function call.

let size = 2
// Invalid: Array-size must be an integer literal
let numbers: [Int; size] = []
// Declare a fixed-sized array of integers
// which always contains exactly two elements.
//
let array: [Int8; 2] = [1, 2]
// Declare a fixed-sized array of fixed-sized arrays of integers.
// The inner arrays always contain exactly three elements,
// the outer array always contains two elements.
//
let arrays: [[Int16; 3]; 2] = [
    [1, 2, 3],
    [4, 5, 6]
]
// Declare a variable length array of integers
var variableLengthArray: [Int] = []
// Mixing values with different types is possible
// by declaring the expected array type
// with the common supertype of all values.
//
let mixedValues: [AnyStruct] = ["some string", 42]

Array types are covariant in their element types. For example, [Int] is a subtype of [AnyStruct]. This is safe because arrays are value types and not reference types.

Array Indexing

To get the element of an array at a specific index, the indexing syntax can be used: The array is followed by an opening square bracket [, the indexing value, and ends with a closing square bracket ].

Indexes start at 0 for the first element in the array.

Accessing an element which is out of bounds results in a fatal error at run-time and aborts the program.

// Declare an array of integers.
let numbers = [42, 23]
// Get the first number of the array.
//
numbers[0] // is `42`
// Get the second number of the array.
//
numbers[1] // is `23`
// Run-time error: Index 2 is out of bounds, the program aborts.
//
numbers[2]

// Declare an array of arrays of integers, i.e. the type is `[[Int]]`.
let arrays = [[1, 2], [3, 4]]
// Get the first number of the second array.
//
arrays[1][0] // is `3`

To set an element of an array at a specific index, the indexing syntax can be used as well.

// Declare an array of integers.
let numbers = [42, 23]
// Change the second number in the array.
//
// NOTE: The declaration `numbers` is constant, which means that
// the *name* is constant, not the *value* – the value, i.e. the array,
// is mutable and can be changed.
//
numbers[1] = 2
// `numbers` is `[42, 2]`

Array Fields and Functions

Arrays have multiple built-in fields and functions that can be used to get information about and manipulate the contents of the array.

The field length, and the functions concat, and contains are available for both variable-sized and fixed-sized or variable-sized arrays.

_10let length: Int

The number of elements in the array.

_10// Declare an array of integers. _10let numbers = [42, 23, 31, 12] _10 _10// Find the number of elements of the array. _10let length = numbers.length _10 _10// `length` is `4`
_10fun concat(_ array: T): T

Concatenates the parameter array to the end of the array the function is called on, but does not modify that array.

Both arrays must be the same type T.

This function creates a new array whose length is the sum of the length of the array the function is called on and the length of the array given as the parameter.

_12// Declare two arrays of integers. _12let numbers = [42, 23, 31, 12] _12let moreNumbers = [11, 27] _12 _12// Concatenate the array `moreNumbers` to the array `numbers` _12// and declare a new variable for the result. _12// _12let allNumbers = numbers.concat(moreNumbers) _12 _12// `allNumbers` is `[42, 23, 31, 12, 11, 27]` _12// `numbers` is still `[42, 23, 31, 12]` _12// `moreNumbers` is still `[11, 27]`
_10fun contains(_ element: T): Bool

Returns true if the given element of type T is in the array.

_15// Declare an array of integers. _15let numbers = [42, 23, 31, 12] _15 _15// Check if the array contains 11. _15let containsEleven = numbers.contains(11) _15// `containsEleven` is `false` _15 _15// Check if the array contains 12. _15let containsTwelve = numbers.contains(12) _15// `containsTwelve` is `true` _15 _15// Invalid: Check if the array contains the string "Kitty". _15// This results in a type error, as the array only contains integers. _15// _15let containsKitty = numbers.contains("Kitty")
_10fun firstIndex(of: T): Int?

Returns the index of the first element matching the given object in the array, nil if no match. Available if T is not resource-kinded and equatable.

_10 // Declare an array of integers. _10 let numbers = [42, 23, 31, 12] _10 _10 // Check if the array contains 31 _10 let index = numbers.firstIndex(of: 31) _10 // `index` is 2 _10 _10 // Check if the array contains 22 _10 let index = numbers.firstIndex(of: 22) _10 // `index` is nil
_10fun slice(from: Int, upTo: Int): [T]

Returns an array slice of the elements in the given array from start index from up to, but not including, the end index upTo. This function creates a new array whose length is upTo - from. It does not modify the original array. If either of the parameters are out of the bounds of the array, or the indices are invalid (from > upTo), then the function will fail.

_11let example = [1, 2, 3, 4] _11 _11// Create a new slice of part of the original array. _11let slice = example.slice(from: 1, upTo: 3) _11// `slice` is now `[2, 3]` _11 _11// Run-time error: Out of bounds index, the program aborts. _11let outOfBounds = example.slice(from: 2, upTo: 10) _11 _11// Run-time error: Invalid indices, the program aborts. _11let invalidIndices = example.slice(from: 2, upTo: 1)

Variable-size Array Functions

The following functions can only be used on variable-sized arrays. It is invalid to use one of these functions on a fixed-sized array.

_10fun append(_ element: T): Void

Adds the new element element of type T to the end of the array.

The new element must be the same type as all the other elements in the array.

This function mutates the array.

_10// Declare an array of integers. _10let numbers = [42, 23, 31, 12] _10 _10// Add a new element to the array. _10numbers.append(20) _10// `numbers` is now `[42, 23, 31, 12, 20]` _10 _10// Invalid: The parameter has the wrong type `String`. _10numbers.append("SneakyString")
_10fun appendAll(_ array: T): Void

Adds all the elements from array to the end of the array the function is called on.

Both arrays must be the same type T.

This function mutates the array.

_10// Declare an array of integers. _10let numbers = [42, 23] _10 _10// Add new elements to the array. _10numbers.appendAll([31, 12, 20]) _10// `numbers` is now `[42, 23, 31, 12, 20]` _10 _10// Invalid: The parameter has the wrong type `[String]`. _10numbers.appendAll(["Sneaky", "String"])
_10fun insert(at: Int, _ element: T): Void

Inserts the new element element of type T at the given index of the array.

The new element must be of the same type as the other elements in the array.

The index must be within the bounds of the array. If the index is outside the bounds, the program aborts.

The existing element at the supplied index is not overwritten.

All the elements after the new inserted element are shifted to the right by one.

This function mutates the array.

_10// Declare an array of integers. _10let numbers = [42, 23, 31, 12] _10 _10// Insert a new element at position 1 of the array. _10numbers.insert(at: 1, 20) _10// `numbers` is now `[42, 20, 23, 31, 12]` _10 _10// Run-time error: Out of bounds index, the program aborts. _10numbers.insert(at: 12, 39)
_10fun remove(at: Int): T

Removes the element at the given index from the array and returns it.

The index must be within the bounds of the array. If the index is outside the bounds, the program aborts.

This function mutates the array.

_10// Declare an array of integers. _10let numbers = [42, 23, 31] _10 _10// Remove element at position 1 of the array. _10let twentyThree = numbers.remove(at: 1) _10// `numbers` is now `[42, 31]` _10// `twentyThree` is `23` _10 _10// Run-time error: Out of bounds index, the program aborts. _10numbers.remove(at: 19)
_10fun removeFirst(): T

Removes the first element from the array and returns it.

The array must not be empty. If the array is empty, the program aborts.

This function mutates the array.

_15// Declare an array of integers. _15let numbers = [42, 23] _15 _15// Remove the first element of the array. _15let fortytwo = numbers.removeFirst() _15// `numbers` is now `[23]` _15// `fortywo` is `42` _15 _15// Remove the first element of the array. _15let twentyThree = numbers.removeFirst() _15// `numbers` is now `[]` _15// `twentyThree` is `23` _15 _15// Run-time error: The array is empty, the program aborts. _15numbers.removeFirst()
_10fun removeLast(): T

Removes the last element from the array and returns it.

The array must not be empty. If the array is empty, the program aborts.

This function mutates the array.

_15// Declare an array of integers. _15let numbers = [42, 23] _15 _15// Remove the last element of the array. _15let twentyThree = numbers.removeLast() _15// `numbers` is now `[42]` _15// `twentyThree` is `23` _15 _15// Remove the last element of the array. _15let fortyTwo = numbers.removeLast() _15// `numbers` is now `[]` _15// `fortyTwo` is `42` _15 _15// Run-time error: The array is empty, the program aborts. _15numbers.removeLast()

Dictionaries

Dictionaries are mutable, unordered collections of key-value associations. Dictionaries may contain a key only once and may contain a value multiple times.

Dictionary literals start with an opening brace { and end with a closing brace }. Keys are separated from values by a colon, and key-value associations are separated by commas.

// An empty dictionary
//
{}
// A dictionary which associates integers with booleans
//
{
    1: true,
    2: false
}

Dictionary Types

Dictionary types have the form {K: V}, where K is the type of the key, and V is the type of the value. For example, a dictionary with Int keys and Bool values has type {Int: Bool}.

In a dictionary, all keys must have a type that is a subtype of the dictionary's key type (K) and all values must have a type that is a subtype of the dictionary's value type (V).

// Declare a constant that has type `{Int: Bool}`,
// a dictionary mapping integers to booleans.
//
let booleans = {
    1: true,
    0: false
}
// Declare a constant that has type `{Bool: Int}`,
// a dictionary mapping booleans to integers.
//
let integers = {
    true: 1,
    false: 0
}
// Mixing keys with different types, and mixing values with different types,
// is possible by declaring the expected dictionary type with the common supertype
// of all keys, and the common supertype of all values.
//
let mixedValues: {String: AnyStruct} = {
    "a": 1,
    "b": true
}

Dictionary types are covariant in their key and value types. For example, {Int: String} is a subtype of {AnyStruct: String} and also a subtype of {Int: AnyStruct}. This is safe because dictionaries are value types and not reference types.

Dictionary Access

To get the value for a specific key from a dictionary, the access syntax can be used: The dictionary is followed by an opening square bracket [, the key, and ends with a closing square bracket ].

Accessing a key returns an optional: If the key is found in the dictionary, the value for the given key is returned, and if the key is not found, nil is returned.

// Declare a constant that has type `{Int: Bool}`,
// a dictionary mapping integers to booleans.
//
let booleans = {
    1: true,
    0: false
}
// The result of accessing a key has type `Bool?`.
//
booleans[1]  // is `true`
booleans[0]  // is `false`
booleans[2]  // is `nil`
// Invalid: Accessing a key which does not have type `Int`.
//
booleans["1"]

// Declare a constant that has type `{Bool: Int}`,
// a dictionary mapping booleans to integers.
//
let integers = {
    true: 1,
    false: 0
}
// The result of accessing a key has type `Int?`
//
integers[true] // is `1`
integers[false] // is `0`

To set the value for a key of a dictionary, the access syntax can be used as well.

// Declare a constant that has type `{Int: Bool}`,
// a dictionary mapping booleans to integers.
//
let booleans = {
    1: true,
    0: false
}
// Assign new values for the keys `1` and `0`.
//
booleans[1] = false
booleans[0] = true
// `booleans` is `{1: false, 0: true}`

Dictionary Fields and Functions

_10let length: Int

The number of entries in the dictionary.

_10// Declare a dictionary mapping strings to integers. _10let numbers = {"fortyTwo": 42, "twentyThree": 23} _10 _10// Find the number of entries of the dictionary. _10let length = numbers.length _10 _10// `length` is `2`
_10fun insert(key: K, _ value: V): V?

Inserts the given value of type V into the dictionary under the given key of type K.

The inserted key must have the same type as the dictionary's key type, and the inserted value must have the same type as the dictionary's value type.

Returns the previous value as an optional if the dictionary contained the key, otherwise nil.

Updates the value if the dictionary already contained the key.

This function mutates the dictionary.

_11// Declare a dictionary mapping strings to integers. _11let numbers = {"twentyThree": 23} _11 _11// Insert the key `"fortyTwo"` with the value `42` into the dictionary. _11// The key did not previously exist in the dictionary, _11// so the result is `nil` _11// _11let old = numbers.insert(key: "fortyTwo", 42) _11 _11// `old` is `nil` _11// `numbers` is `{"twentyThree": 23, "fortyTwo": 42}`
_10fun remove(key: K): V?

Removes the value for the given key of type K from the dictionary.

Returns the value of type V as an optional if the dictionary contained the key, otherwise nil.

This function mutates the dictionary.

_19// Declare a dictionary mapping strings to integers. _19let numbers = {"fortyTwo": 42, "twentyThree": 23} _19 _19// Remove the key `"fortyTwo"` from the dictionary. _19// The key exists in the dictionary, _19// so the value associated with the key is returned. _19// _19let fortyTwo = numbers.remove(key: "fortyTwo") _19 _19// `fortyTwo` is `42` _19// `numbers` is `{"twentyThree": 23}` _19 _19// Remove the key `"oneHundred"` from the dictionary. _19// The key does not exist in the dictionary, so `nil` is returned. _19// _19let oneHundred = numbers.remove(key: "oneHundred") _19 _19// `oneHundred` is `nil` _19// `numbers` is `{"twentyThree": 23}`
_10let keys: [K]

Returns an array of the keys of type K in the dictionary. This does not modify the dictionary, just returns a copy of the keys as an array. If the dictionary is empty, this returns an empty array. The ordering of the keys is undefined.

_10// Declare a dictionary mapping strings to integers. _10let numbers = {"fortyTwo": 42, "twentyThree": 23} _10 _10// Find the keys of the dictionary. _10let keys = numbers.keys _10 _10// `keys` has type `[String]` and is `["fortyTwo","twentyThree"]`
_10let values: [V]

Returns an array of the values of type V in the dictionary. This does not modify the dictionary, just returns a copy of the values as an array. If the dictionary is empty, this returns an empty array.

This field is not available if V is a resource type.

_10// Declare a dictionary mapping strings to integers. _10let numbers = {"fortyTwo": 42, "twentyThree": 23} _10 _10// Find the values of the dictionary. _10let values = numbers.values _10 _10// `values` has type [Int] and is `[42, 23]`
_10fun containsKey(key: K): Bool

Returns true if the given key of type K is in the dictionary.

_15// Declare a dictionary mapping strings to integers. _15let numbers = {"fortyTwo": 42, "twentyThree": 23} _15 _15// Check if the dictionary contains the key "twentyFive". _15let containsKeyTwentyFive = numbers.containsKey("twentyFive") _15// `containsKeyTwentyFive` is `false` _15 _15// Check if the dictionary contains the key "fortyTwo". _15let containsKeyFortyTwo = numbers.containsKey("fortyTwo") _15// `containsKeyFortyTwo` is `true` _15 _15// Invalid: Check if the dictionary contains the key 42. _15// This results in a type error, as the key type of the dictionary is `String`. _15// _15let containsKey42 = numbers.containsKey(42)
_10fun forEachKey(_ function: ((K): Bool)): Void

Iterate through all the keys in the dictionary, exiting early if the passed function returns false. This is more efficient than calling .keys and iterating over the resulting array, since an intermediate allocation is avoided. The order of key iteration is undefined, similar to .keys.

_18// Take in a targetKey to look for, and a dictionary to iterate through. _18fun myContainsKey(targetKey: String, dictionary: {String: Int}) { _18 // Declare an accumulator that we'll capture inside a closure. _18 var found = false _18 _18 // At each step, `key` will be bound to another key from `dictionary`. _18 dictionary.forEachKey(fun (key: String): Bool { _18 found = key == targetKey _18 _18 // The returned boolean value, signals whether to continue iterating. _18 // This allows for control flow during the iteration process: _18 // true = `continue` _18 // false = `break` _18 return !found _18 }) _18 _18 return found _18}

Dictionary Keys

Dictionary keys must be hashable and equatable.

Most of the built-in types, like booleans and integers, are hashable and equatable, so can be used as keys in dictionaries.

Booleans​

Numeric Literals​

Integers​

Integer Functions​

Fixed-Point Numbers​

Fixed-Point Number Functions​

Minimum and maximum values​

Saturation Arithmetic​

Floating-Point Numbers​

Addresses​

Address Functions​

AnyStruct and AnyResource​

Optionals​

Never​

Strings and Characters​

String Fields and Functions​

Character Fields and Functions​

Arrays​

Array Types​

Array Indexing​

Array Fields and Functions​

Variable-size Array Functions​

Dictionaries​

Dictionary Types​

Dictionary Access​

Dictionary Fields and Functions​

Dictionary Keys​