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

Merge branch 'master' into merge

Browse source
This commit is contained in:
Vyacheslav Egorov 2023-03-03 15:53:16 +02:00
commit ca34b44be6
3 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
SECURITY.md
View file

@ -1,6 +1,6 @@
# Security Guarantees # Security Guarantees
Luau provides a safe sandbox that scripts can not escape from, short of vulnerabilities in custom C functions exposed by the host. This includes the virtual machine and builtin libraries. Luau provides a safe sandbox that scripts can not escape from, short of vulnerabilities in custom C functions exposed by the host. This includes the virtual machine and builtin libraries. Notably this currently does *not* include the work-in-progress native code generation facilities.
Any source code can not result in memory safety errors or crashes during its compilation or execution. Violations of memory safety are considered vulnerabilities. Any source code can not result in memory safety errors or crashes during its compilation or execution. Violations of memory safety are considered vulnerabilities.

6
docs/_pages/library.md
View file

@ -374,19 +374,19 @@ Concatenate all elements of `a` with indices in range `[f..t]` together, using `
function table.foreach<K, V, R>(t: { [K]: V }, f: (K, V) -> R?): R? function table.foreach<K, V, R>(t: { [K]: V }, f: (K, V) -> R?): R?
``` ```
Iterates over all elements of the table in unspecified order; for each key-value pair, calls `f` and returns the result of `f` if it's non-nil. If all invocations of `f` returned `nil`, returns no values. Iterates over all elements of the table in unspecified order; for each key-value pair, calls `f` and returns the result of `f` if it's non-nil. If all invocations of `f` returned `nil`, returns no values. This function has been deprecated and is not recommended for use in new code; use `for` loop instead.
``` ```
function table.foreachi<V, R>(t: {V}, f: (number, V) -> R?): R? function table.foreachi<V, R>(t: {V}, f: (number, V) -> R?): R?
``` ```
Iterates over numeric keys of the table in `[1..#t]` range in order; for each key-value pair, calls `f` and returns the result of `f` if it's non-nil. If all invocations of `f` returned `nil`, returns no values. Iterates over numeric keys of the table in `[1..#t]` range in order; for each key-value pair, calls `f` and returns the result of `f` if it's non-nil. If all invocations of `f` returned `nil`, returns no values. This function has been deprecated and is not recommended for use in new code; use `for` loop instead.
``` ```
function table.getn<V>(t: {V}): number function table.getn<V>(t: {V}): number
``` ```
Returns the length of table `t` (equivalent to `#t`). Returns the length of table `t`. This function has been deprecated and is not recommended for use in new code; use `#t` instead.
``` ```
function table.maxn<V>(t: {V}): number function table.maxn<V>(t: {V}): number

4
rfcs/deprecate-table-getn-foreach.md
View file

@ -6,12 +6,10 @@ Mark table.getn/foreach/foreachi as deprecated
## Motivation ## Motivation
`table.getn` was deprecated in Lua 5.1 that Luau is based on. `table.getn`, `table.foreach` and `table.foreachi` were deprecated in Lua 5.1 that Luau is based on, and removed in Lua 5.2.
`table.getn(x)` is equivalent to `rawlen(x)` when `x` is a table; when `x` is not a table, `table.getn` produces an error. It's difficult to imagine code where `table.getn(x)` is better than either `#x` (idiomatic) or `rawlen(x)` (fully compatible replacement). However, `table.getn` is slower and provides yet another way to perform an operation, leading new users of the language to use it unknowingly. `table.getn(x)` is equivalent to `rawlen(x)` when `x` is a table; when `x` is not a table, `table.getn` produces an error. It's difficult to imagine code where `table.getn(x)` is better than either `#x` (idiomatic) or `rawlen(x)` (fully compatible replacement). However, `table.getn` is slower and provides yet another way to perform an operation, leading new users of the language to use it unknowingly.
`table.foreach` and `table.foreachi` were deprecated in Lua 5.2.
`table.foreach` is equivalent to a `for .. pairs` loop; `table.foreachi` is equivalent to a `for .. ipairs` loop; both may also be replaced by generalized iteration. Both functions are significantly slower than equivalent `for` loop replacements, are more restrictive because the function can't yield, and result in new users (particularly coming from JS background) unknowingly using these thus producing non-idiomatic non-performant code. `table.foreach` is equivalent to a `for .. pairs` loop; `table.foreachi` is equivalent to a `for .. ipairs` loop; both may also be replaced by generalized iteration. Both functions are significantly slower than equivalent `for` loop replacements, are more restrictive because the function can't yield, and result in new users (particularly coming from JS background) unknowingly using these thus producing non-idiomatic non-performant code.
In both cases, the functions bring no value over other library or language alternatives, and thus just serve as a distraction. In both cases, the functions bring no value over other library or language alternatives, and thus just serve as a distraction.