Tuples

A tuple is a general-purpose static-length aggregation of types, in other words, it's a single type that consists of an aggregate of zero or more types. The internal types that make up a tuple, and the tuple's arity, define the tuple's type.

Declare

To declare a tuple we wrap the values in ().

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:declare}}

Retrieve by Index

Values can be retrieved individually from the tuple by specifying the index.

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:index}}

Mutate

A value can be mutated in a tuple as long as the tuple is declared to be mutable and the new value has the same type as the previous value.

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:internal_mutability}}

The entire tuple can be overwritten when it is mutable and the type for each value is the same.

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:mutability}}

Destructure

Elements can be destructured from a tuple into individual variables.

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:destructure}}

We can also ignore elements when destructuring.

{{#include ../../../code/language/built-ins/tuples/src/lib.sw:ignore_destructure}}