Grain provides some built-in types to be used throughout your programs.

Edit on GitHub

---

enum Bool {
  true,
  false
}

The type of Grain booleans, i.e. true or false.

type Char

The type of Grain Unicode characters, e.g. 'g', '🌾', '💻'.

type String

The type of Grain strings, e.g. "The quick brown fox jumps over the lazy dog.".

type Bytes

The type of Grain byte sequences, e.g. b"The quick brown fox jumps over the lazy dog."

enum Void {
  void
}

The type of void, Grain’s special type for indicating the absence of a meaningful value i.e. Grain’s unit type.

enum Option<a> {
  Some(a),
  None
}

The type of Grain options (e.g. Some(1) or None). The a is the type of the value. Options are analagous to nullable values in some other languages, but are much safer to work with due to the nullability being encoded explicitly in the type.

enum Result<t, e> {
  Ok(t),
  Err(e)
}

The type of Grain results (e.g. Ok(1) or Err("Something went wrong")). The t and e are the types of the value and error, respectively. This is useful for functions that might fail.

type Array<a>

The type of Grain arrays, e.g. [> 1, 2, 3]. Arrays are fixed-length and allow for efficient get/set operations at any index.

type List<a>

The type of Grain lists (linked lists), e.g. [1, 2, 3]. Lists are immutable and allow for values to be efficiently appended.

type Box<a>

The type of Grain boxes. Boxes are wrappers that allow the internal data to be swapped during execution.

record Range<a> {
  rangeStart: a,
  rangeEnd: a
}

A range of values, with a start and end value.

type Rational

The type of Grain rationals, e.g. 2/3r. Rationals are represented as a numerator and denominator.

type Number

The type of Grain numbers, e.g. 42, 0x2a, 23.19, 2/3. Grain numbers can be arbitrarily large integers, floats, or rationals.

type BigInt

The type of arbitrarily large integers, e.g. 42t, 9_223_372_036_854_775_808t.

type Int8

The type of 8-bit integers, e.g. 127s, -127s, 0x01s.

type Uint8

The type of 8-bit unsigned integers, e.g. 255us, 42us, 0x01us.

type Int16

The type of 16-bit integers, e.g. 32768S, -32768S, 0x01S.

type Uint16

The type of 16-bit unsigned integers, e.g. 65535uS, 42uS, 0x01uS.

type Int32

The type of 32-bit integers, e.g. 42l, 0x2al.

type Uint32

The type of 32-bit unsigned integers, e.g. 42ul, 0x2aul.

type Int64

The type of 64-bit integers, e.g. 42L, 0x2aL.

type Uint64

The type of 64-bit unsigned integers, e.g. 42uL, 0x2auL.

type Float32

The type of 32-bit floating-point numbers, e.g. 3.5f.

type Float64

The type of 64-bit floating-point numbers, e.g. 3.5d.

type Exception

The type of Grain exceptions. Exceptions represent errors that have occured in a program.