`nupp.types`

Compiler-only type inspection and construction inside comptime function declarations. Every member is an ordinary checked compile-time value; none has a runtime representation.

Module contents

Functions

Function	Kind	Description
`affine`	comptime function
`arguments`	comptime function	The type arguments a generic declaration was applied to.
`array`	comptime function
`borrowed`	comptime function
`carray`	comptime function
`constof`	comptime function
`construction`	comptime function	The parameters a record or struct is constructed with, as a pack whose slots carry their names.
`describe`	comptime function
`elements`	comptime function	The fixed elements of a composite type, or a pack's fixed head.
`error`	comptime function
`fields`	comptime function
`formatArguments`	comptime function	Computes the arguments consumed by a literal Lua format string.
`function_`	comptime function
`indexer`	comptime function
`intersection`	comptime function
`kind`	comptime function
`literal`	comptime function
`map`	comptime function
`nonExhaustive`	comptime function
`optional`	comptime function
`pack`	comptime function
`parameters`	comptime function
`pinned`	comptime function
`pointer`	comptime function
`readAt`	comptime function
`readKeys`	comptime function
`results`	comptime function
`sameNominal`	comptime function	Whether two types name the same nominal declaration, ignoring its arguments.
`shape`	comptime function
`tuple`	comptime function
`union`	comptime function
`writeAt`	comptime function
`writeKeys`	comptime function

Values

Value	Kind	Description
`any`	comptime type
`boolean`	comptime type
`cdata`	comptime type
`cstring`	comptime type
`float`	comptime type
`int16`	comptime type
`int32`	comptime type
`int64`	comptime type
`int8`	comptime type
`integer`	comptime type
`never`	comptime type
`nil_`	comptime type
`number`	comptime type
`string`	comptime type
`table_`	comptime type
`thread`	comptime type
`uint16`	comptime type
`uint32`	comptime type
`uint64`	comptime type
`uint8`	comptime type
`unknown`	comptime type
`userdata`	comptime type
`voidptr`	comptime type

Functions#

`affine`comptime function#

local affine: comptime function(representation: type): type
& comptime function(representation: type, const terminal: function): type

Arguments

Name	Type	Description
`representation`	`type`
`terminal`	`any`

Returns

Type	Description
`type`

`arguments`comptime function#

local arguments: comptime function(value: type): {type}

The type arguments a generic declaration was applied to.

Empty for a type that is not a generic application, so a caller may ask without knowing which it has.

Arguments

Name	Type	Description
`value`	`type`	the applied type to inspect

Returns

Type	Description
`{type}`	one handle per argument, in declaration order

`array`comptime function#

local array: comptime function(element: type): type

Arguments

Name	Type	Description
`element`	`type`

Returns

Type	Description
`type`

`borrowed`comptime function#

local borrowed: comptime function(inner: type): type

Arguments

Name	Type	Description
`inner`	`type`

Returns

Type	Description
`type`

`carray`comptime function#

local carray: comptime function(element: type, count: integer?): type

Arguments

Name	Type	Description
`element`	`type`
`count`	`integer?`

Returns

Type	Description
`type`

`constof`comptime function#

local constof: comptime function(inner: type): type

Arguments

Name	Type	Description
`inner`	`type`

Returns

Type	Description
`type`

`construction`comptime function#

local construction: comptime function(value: type): typepack

The parameters a record or struct is constructed with, as a pack whose slots carry their names.

The one declared constructor's parameters, or the stored fields in declaration order when the declaration has no constructor; a field with a default, or one that admits nil, is an optional slot. Written as ...: unpackof nupp.types.construction(E), the pack is a parameter list a call binds by position or by name, the way it would for new E(...).

Arguments

Name	Type	Description
`value`	`type`	the record or struct to inspect

Returns

Type	Description
`typepack`	its construction contract

Raises

when the declaration has several constructors, which is no single contract

`describe`comptime function#

local describe: comptime function(value: type | typepack): {
    readonly kind: string,
    readonly sourceKind: string?,

    --- Reports the nominal declaration category without expanding a reference.
    readonly declarationKind: string?,
    readonly name: string?,
    readonly value: (string | boolean | integer)?,
    readonly element: type?,
    readonly members: {type}?,
    readonly fields: {{
        readonly name: string,
        readonly read: type?,
        readonly write: type?
    }}?,
    readonly indexer: type?,
    readonly readKey: type?,
    readonly readValue: type?,
    readonly writeKey: type?,
    readonly writeValue: type?,
    readonly nominal: boolean?,
    readonly head: {type}?,
    readonly tail: type?,
    readonly modes: {string}?,
    readonly count: integer?,
    readonly parameters: typepack?,
    readonly results: typepack?
}

Arguments

Name	Type	Description
`value`	`type \| typepack`

Returns

Type Description

{ readonly kind: string, readonly sourceKind: string?, --- Reports the nominal declaration category without expanding a reference. readonly declarationKind: string?, readonly name: string?, readonly value: (string | boolean | integer)?, readonly element: type?, readonly members: {type}?, readonly fields: {{ readonly name: string, readonly read: type?, readonly write: type? }}?, readonly indexer: type?, readonly readKey: type?, readonly readValue: type?, readonly writeKey: type?, readonly writeValue: type?, readonly nominal: boolean?, readonly head: {type}?, readonly tail: type?, readonly modes: {string}?, readonly count: integer?, readonly parameters: typepack?, readonly results: typepack? }

Type	Description
{ readonly kind: string, readonly sourceKind: string?, --- Reports the nominal declaration category without expanding a reference. readonly declarationKind: string?, readonly name: string?, readonly value: (string \| boolean \| integer)?, readonly element: type?, readonly members: {type}?, readonly fields: {{ readonly name: string, readonly read: type?, readonly write: type? }}?, readonly indexer: type?, readonly readKey: type?, readonly readValue: type?, readonly writeKey: type?, readonly writeValue: type?, readonly nominal: boolean?, readonly head: {type}?, readonly tail: type?, readonly modes: {string}?, readonly count: integer?, readonly parameters: typepack?, readonly results: typepack? }

`elements`comptime function#

local elements: comptime function(value: type | typepack): {type}

The fixed elements of a composite type, or a pack's fixed head.

Arguments

Name	Type	Description
`value`	`type \| typepack`	the type or type pack to take apart

Returns

Type	Description
`{type}`	one handle per element, in declaration order

`error`comptime function#

local error: comptime function(message: string): never

Arguments

Name	Type	Description
`message`	`string`

Returns

Type	Description
`never`

`fields`comptime function#

local fields: comptime function(value: type): {{
    readonly name: string,
    readonly read: type?,
    readonly write: type?
}}

Arguments

Name	Type	Description
`value`	`type`

Returns

Type	Description
`{{ readonly name: string, readonly read: type?, readonly write: type? }}`

`formatArguments`comptime function#

local formatArguments: comptime function(format: type): typepack

Computes the arguments consumed by a literal Lua format string.

A broad string produces an open any pack. %? is reserved for compiler-lowered formatting APIs.

Arguments

Name	Type	Description
`format`	`type`	the format-string type to inspect

Returns

Type	Description
`typepack`	the argument pack consumed by its directives

`function_`comptime function#

local function_: comptime function(parameters: typepack, results: typepack): type

Arguments

Name	Type	Description
`parameters`	`typepack`
`results`	`typepack`

Returns

Type	Description
`type`

`indexer`comptime function#

local indexer: comptime function(readKey: type?, readValue: type?, writeKey: type?, writeValue: type?): type

Arguments

Name	Type	Description
`readKey`	`type?`
`readValue`	`type?`
`writeKey`	`type?`
`writeValue`	`type?`

Returns

Type	Description
`type`

`intersection`comptime function#

local intersection: comptime function(members: {type}): type

Arguments

Name	Type	Description
`members`	`{type}`

Returns

Type	Description
`type`

`kind`comptime function#

local kind: comptime function(value: type | typepack): string

Arguments

Name	Type	Description
`value`	`type \| typepack`

Returns

Type	Description
`string`

`literal`comptime function#

local literal: comptime function(value: string | boolean | integer): type

Arguments

Name	Type	Description
`value`	`string \| boolean \| integer`

Returns

Type	Description
`type`

`map`comptime function#

local map: comptime function(readKey: type, readValue: type, writeKey: type?, writeValue: type?): type

Arguments

Name	Type	Description
`readKey`	`type`
`readValue`	`type`
`writeKey`	`type?`
`writeValue`	`type?`

Returns

Type	Description
`type`

`nonExhaustive`comptime function#

local nonExhaustive: comptime function(): type

Returns

Type	Description
`type`

`optional`comptime function#

local optional: comptime function(inner: type): type

Arguments

Name	Type	Description
`inner`	`type`

Returns

Type	Description
`type`

`pack`comptime function#

local pack: comptime function(head: {type}, tail: type?, modes: {string}?): typepack

Arguments

Name	Type	Description
`head`	`{type}`
`tail`	`type?`
`modes`	`{string}?`

Returns

Type	Description
`typepack`

`parameters`comptime function#

local parameters: comptime function(callable: type): typepack

Arguments

Name	Type	Description
`callable`	`type`

Returns

Type	Description
`typepack`

`pinned`comptime function#

local pinned: comptime function(inner: type): type

Arguments

Name	Type	Description
`inner`	`type`

Returns

Type	Description
`type`

`pointer`comptime function#

local pointer: comptime function(inner: type): type

Arguments

Name	Type	Description
`inner`	`type`

Returns

Type	Description
`type`

`readAt`comptime function#

local readAt: comptime function(value: type, key: type): type

Arguments

Name	Type	Description
`value`	`type`
`key`	`type`

Returns

Type	Description
`type`

`readKeys`comptime function#

local readKeys: comptime function(value: type): {type}

Arguments

Name	Type	Description
`value`	`type`

Returns

Type	Description
`{type}`

`results`comptime function#

local results: comptime function(callable: type): typepack

Arguments

Name	Type	Description
`callable`	`type`

Returns

Type	Description
`typepack`

`sameNominal`comptime function#

local sameNominal: comptime function(left: type, right: type): boolean

Whether two types name the same nominal declaration, ignoring its arguments.

Aliases and ownership wrappers are transparent. Structural types and two different nominal declarations answer false even when their shapes match.

Arguments

Name	Type	Description
`left`	`type`
`right`	`type`

Returns

Type	Description
`boolean`

`shape`comptime function#

local shape: comptime function(fields: const{{
    readonly name: string,
    readonly read: type?,
    readonly write: type?
}}, indexer: type?): type

Arguments

Name	Type	Description
`fields`	`const{{ readonly name: string, readonly read: type?, readonly write: type? }}`
`indexer`	`type?`

Returns

Type	Description
`type`

`tuple`comptime function#

local tuple: comptime function(elements: {type}): type

Arguments

Name	Type	Description
`elements`	`{type}`

Returns

Type	Description
`type`

`union`comptime function#

local union: comptime function(members: {type}): type

Arguments

Name	Type	Description
`members`	`{type}`

Returns

Type	Description
`type`

`writeAt`comptime function#

local writeAt: comptime function(value: type, key: type): type

Arguments

Name	Type	Description
`value`	`type`
`key`	`type`

Returns

Type	Description
`type`

`writeKeys`comptime function#

local writeKeys: comptime function(value: type): {type}

Arguments

Name	Type	Description
`value`	`type`

Returns

Type	Description
`{type}`

Values#

`any`comptime type#

local any: comptime type

`boolean`comptime type#

local boolean: comptime type

`cdata`comptime type#

local cdata: comptime type

`cstring`comptime type#

local cstring: comptime type

`float`comptime type#

local float: comptime type

`int16`comptime type#

local int16: comptime type

`int32`comptime type#

local int32: comptime type

`int64`comptime type#

local int64: comptime type

`int8`comptime type#

local int8: comptime type

`integer`comptime type#

local integer: comptime type

`never`comptime type#

local never: comptime type

`nil_`comptime type#

local nil_: comptime type

`number`comptime type#

local number: comptime type

`string`comptime type#

local string: comptime type

`table_`comptime type#

local table_: comptime type

`thread`comptime type#

local thread: comptime type

`uint16`comptime type#

local uint16: comptime type

`uint32`comptime type#

local uint32: comptime type

`uint64`comptime type#

local uint64: comptime type

`uint8`comptime type#

local uint8: comptime type

`unknown`comptime type#

local unknown: comptime type

`userdata`comptime type#

local userdata: comptime type

`voidptr`comptime type#

local voidptr: comptime type

nupp.types

Module contents

Functions

Values

Functions#

affinecomptime function#

Arguments

Returns

argumentscomptime function#

Arguments

Returns

arraycomptime function#

Arguments

Returns

borrowedcomptime function#

Arguments

Returns

carraycomptime function#

Arguments

Returns

constofcomptime function#

Arguments

Returns

constructioncomptime function#

Arguments

Returns

Raises

describecomptime function#

Arguments

Returns

elementscomptime function#

Arguments

Returns

errorcomptime function#

Arguments

Returns

fieldscomptime function#

Arguments

Returns

formatArgumentscomptime function#

Arguments

Returns

function_comptime function#

Arguments

Returns

indexercomptime function#

Arguments

Returns

intersectioncomptime function#

Arguments

Returns

kindcomptime function#

Arguments

Returns

literalcomptime function#

Arguments

Returns

mapcomptime function#

Arguments

Returns

nonExhaustivecomptime function#

Returns

optionalcomptime function#

Arguments

Returns

packcomptime function#

Arguments

Returns

parameterscomptime function#

Arguments

Returns

pinnedcomptime function#

Arguments

Returns

pointercomptime function#

Arguments

Returns

readAtcomptime function#

Arguments

Returns

`nupp.types`

`affine`comptime function#

`arguments`comptime function#

`array`comptime function#

`borrowed`comptime function#

`carray`comptime function#

`constof`comptime function#

`construction`comptime function#

`describe`comptime function#

`elements`comptime function#

`error`comptime function#

`fields`comptime function#

`formatArguments`comptime function#

`function_`comptime function#

`indexer`comptime function#

`intersection`comptime function#

`kind`comptime function#

`literal`comptime function#

`map`comptime function#

`nonExhaustive`comptime function#

`optional`comptime function#

`pack`comptime function#

`parameters`comptime function#

`pinned`comptime function#

`pointer`comptime function#

`readAt`comptime function#

`readKeys`comptime function#

`results`comptime function#

`sameNominal`comptime function#

`shape`comptime function#

`tuple`comptime function#

`union`comptime function#

`writeAt`comptime function#

`writeKeys`comptime function#

`any`comptime type#

`boolean`comptime type#

`cdata`comptime type#

`cstring`comptime type#

`float`comptime type#

`int16`comptime type#

`int32`comptime type#

`int64`comptime type#

`int8`comptime type#

`integer`comptime type#

`never`comptime type#

`nil_`comptime type#

`number`comptime type#

`string`comptime type#

`table_`comptime type#

`thread`comptime type#

`uint16`comptime type#

`uint32`comptime type#

`uint64`comptime type#

`uint8`comptime type#

`unknown`comptime type#

`userdata`comptime type#

`voidptr`comptime type#