module type

Type definitions (type.Type and implementations).

index

tables

• T  – Magic table containing all Primitive types.

class type

• type\eq(a, b)  – check two values of this type for equality.
• type\get(key)  – index into this type or throw a error.
• type\mk_sig(init)  – create a SigStream of this type.
• type\mk_evt()  – create a EvtStream of this type.
• type\mk_const(val)  – create a Constant of this type.

class primitive

• Primitive\new(name)  – instantiate a Primitive type.
• primitive.name  – the type's unique name.

class struct

• struct\iter_keys()  – iterate over contained keys and types each iteration, returns a key and associated type
• struct\project(keys)  – create a new struct type with a subset of keys.
• Struct\new(types)  – instantiate a Primitive type.
• struct.types  – the shape and field types of the struct.

class array

• array\iter_keys()  – iterate over contained types each iteration, returns a key and associated type
• Array\new(size, type)  – instantiate an Array type.
• array.size  – the number of elements in this array.
• array.type  – the element type of this array.

details

tables

• T  – Magic table containing all Primitive types.
  When indexed with a string returns a (cached) instance of that type.

class type

• type\eq(a, b)  – check two values of this type for equality.

  parameters:

  • a (any)
  • b (any)

  returns:

  1. (bool)
• type\get(key)  – index into this type or throw a error.

  parameters:

  • key (any)

  returns:

  1. (Type)
• type\mk_sig(init)  – create a SigStream of this type.

  parameters:

  • init (optional any): initial value

  returns:

  1. (SigStream)
• type\mk_evt()  – create a EvtStream of this type.

  returns:

  1. (EvtStream)
• type\mk_const(val)  – create a Constant of this type.

  parameters:

  • val (any): value

  returns:

  1. (Constant)

class primitive

• Primitive\new(name)  – instantiate a Primitive type.

  parameters:

  • name (string): the typename
• primitive.name  – the type's unique name.
  • name (string)

class struct

• struct\iter_keys()  – iterate over contained keys and types each iteration, returns a key and associated type

  returns:

  1. (string): key
  2. (Type): associated type
• struct\project(keys)  – create a new struct type with a subset of keys.

  parameters:

  • keys
• Struct\new(types)  – instantiate a Primitive type.

  parameters:

  • types ({string=Type})
• struct.types  – the shape and field types of the struct.
  • types ({string=Type})

class array

• array\iter_keys()  – iterate over contained types each iteration, returns a key and associated type

  returns:

  1. (number): key
  2. (Type): associated type
• Array\new(size, type)  – instantiate an Array type.

  parameters:

  • size (number)
  • type (Type)
• array.size  – the number of elements in this array.
  • size (number)
• array.type  – the element type of this array.
  • type (Type)