Enums

Enums are lists of constant values, either strings or numbers. By default an enum is of value type int and each case will have an incremented value starting at 0. To get the value associated with a case, use the value property.

enum Natural {
    zero,
    one,
    two,
}

Natural.zero.value == 0;

If the enum's value type is not int, it must be specified between angle brackets after the enum keyword.

enum<str> Country {
    usa = "United States of America",
    uk = "United Kingdom",
    fr = "France",
}

The value type must be one of: str, int, double, pat, rg, ud, void.

To get the enum case from its value, you can call the enum like a function with the value as an argument.

final country = Country("France");
country == .fr;

When the value type is str, you can omit case values which will be the same as the case name.

enum<str> Locale {
    fr,
    it,
    en,
}

Locale.en.value == "en";

If one case value is specified all cases must also have a value.

When it can be inferred, the enum name can be omitted:

object Lang {
    locale: Locale,
}

final lang = Lang{
    locale = .fr,
};