luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-05-04 10:43:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update support-for-type-packs-in-user-defined-type-functions.md

Browse source 
Major update:
Updated function type support for pack types.
This commit is contained in:
Tenebris Noctua 2025-04-13 23:18:16 +03:00 • committed by GitHub
parent 94304b2e57
commit fcc1c274b5
Signed by: DevComp
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
docs/support-for-type-packs-in-user-defined-type-functions.md
View file

@ -36,24 +36,24 @@ type function f(arg: pack)
if typeof(arg) ~= "pack" then error("The given argument is not a type pack!") end if typeof(arg) ~= "pack" then error("The given argument is not a type pack!") end
local unpacked = arg:unpack() -- {string, number} local unpacked = arg:unpack() -- {string, number}
end end
type a = f<(string, number)> type A = f<(string, number)>
``` ```
Creating a type function that returns a function with a type pack: Type-packs can now be placed at the `tail` argument of function types:
```luau ```luau
type function f() type function f()
local newPack = types.pack({types.string, types.number}) -- (string, number) local newPack = types.pack({types.string, types.number, types.pack({any}, true)}) -- (string, number, ...any)
local newVariadicPack = types.pack({types.any}, true) -- ...any
local newfunc = types.newfunction() local newfunc = types.newfunction()
newfunc:setparameters({newPack}, newVariadicPack) newfunc:setparameters({}, newPack)
newfunc:setreturns({newPack}, newVariadicPack) newfunc:setreturns({}, newPack)
return newfunc return newfunc
end end
type A = f<> -- (string, number, ...any) -> (string, number, ...any) type A = f<> -- (string, number, ...any) -> (string, number, ...any)
``` ```
*To maintain backwards-compatibility, `tail` argument will still be able to take `type`s.*
The pack type will also enable generic type packs to be provided to type functions from aliases in the type runtime. The pack type will also enable generic type packs to be provided to type functions from aliases in the type runtime.
Generic type pack arguments will pass the given type pack to the type function. Generic type pack arguments will pass the given type pack to the type function.
@ -61,13 +61,22 @@ Generic type pack arguments will pass the given type pack to the type function.
type function createCallback(args: pack, returns: pack) -- args will be a literal pack, returns will be a variadic pack. type function createCallback(args: pack, returns: pack) -- args will be a literal pack, returns will be a variadic pack.
local newTable = types.newtable() local newTable = types.newtable()
local newfunc = types.newfunction() local newfunc = types.newfunction()
newfunc:setparameters({args}) newfunc:setparameters({}, args)
newfunc:setreturns({returns}) newfunc:setreturns({}, returns)
newTable:setproperty(types.singleton("f"), newfunc) newTable:setproperty(types.singleton("f"), newfunc)
return newTable return newTable
end end
type Callback<Args..., Rets...> = createCallback<Args..., Rets...> type Callback<Args..., Rets...> = createCallback<Args..., Rets...>
type A = Callback<(number, string), ...number> type A = Callback<(number, string), ...number> -- { f: (number, string) -> ...number }
```
Evaluating `typeof(...)` on a `pack` userdata will give the string `"pack"`.
```luau
type function f(arg: pack)
print(typeof(arg)) -- "pack"
end
type a = f<(string, number)>
``` ```
If variadic type functions were to be implemented, type packs could be retrieved like this: If variadic type functions were to be implemented, type packs could be retrieved like this:
@ -81,15 +90,6 @@ end
type a = f<(string, number), ...number> type a = f<(string, number), ...number>
``` ```
Evaluating `typeof(...)` on a `pack` userdata will give the string `"pack"`.
```luau
type function f(arg: pack)
print(typeof(arg)) -- "pack"
end
type a = f<(string, number)>
```
## New pack userdata ## New pack userdata
### `pack` Instance ### `pack` Instance
@ -106,18 +106,21 @@ type a = f<(string, number)>
| New/Update | Library Functions | Return Type | Description | | New/Update | Library Functions | Return Type | Description |
| ------------- | ------------- | ------------- | ------------- | | ------------- | ------------- | ------------- | ------------- |
| New | `pack(args: {pack \| type}, isvariadic: boolean?)` | `pack` | returns an immutable instance of a type pack; when `isvariadic` is true, `args` table can only have one `type`. | | New | `pack(args: {pack \| type}, isvariadic: boolean?)` | `pack` | returns an immutable instance of a type pack; when `isvariadic` is true, `args` table can only have one `type`. |
| Update | `newfunction(parameters: { head: {type}?, tail: type? }, returns: { head: {type}?, tail: type? }, generics: {type}?)` | `type` | `tail` arguments can now accept variadic packs. | Update | `newfunction(parameters: { head: {type}?, tail: type \| pack? }, returns: { head: {type}?, tail: type \| pack? }, generics: {type}?)` | `type` | `tail` arguments can now accept packs.
#### Function `type` instance #### Function `type` instance
| New/Update | Instance Methods | Return Type | Description | | New/Update | Instance Methods | Return Type | Description |
| ------------- | ------------- | ------------- | ------------- | | ------------- | ------------- | ------------- | ------------- |
| Update | `setparameters(head: {type}?, tail: type?)` | `()` | `tail` argument can now accept variadic packs. | | Update | `setparameters(head: {type}?, tail: type \| pack?)` | `()` | `tail` argument can now accept packs. |
| Update | `setreturns(head: {type}?, tail: type?)` | `()` | `tail` argument can now accept variadic packs. | | Update | `setreturns(head: {type}?, tail: type \| pack?)` | `()` | `tail` argument can now accept packs. |
## Drawbacks ## Drawbacks
This may bring additional complexity to type functions, and now variadic types will no longer have special meanings only in a tail spot. This may bring additional complexity to type functions, and since we're bringing a new userdata to the runtime, type functions now get two types of parameters, `type` or `pack`.
This doesn't pose a problem when the arguments are annotated (`arg: type`), but in unannotated arguments (`arg`), this may pose a problem.
To solve this problem, inference can treat all provided arguments as `type`, until it encounters a `pack` related function.
## Alternatives ## Alternatives