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

Update function-buffer-varints.md

Browse source
This commit is contained in:
bmcq-0 2023-12-07 20:48:51 -05:00 • committed by GitHub
parent 07aa7e0928
commit e1644b671d
Signed by: DevComp
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/function-buffer-varints.md
View file

@ -50,15 +50,17 @@ The functions above are inefficient and difficult to understand compared to a li
The `buffer` library will receive 4 new functions:
```
buffer.readleb128(b: buffer, offset: number): number
buffer.readuleb128(b: buffer, offset: number): number
buffer.readleb128(b: buffer, offset: number): (number, number)
buffer.readuleb128(b: buffer, offset: number): (number, number)
buffer.writeleb128(b: buffer, offset: number, value: number): ()
buffer.writeuleb128(b: buffer, offset: number, value: number): ()
buffer.writeleb128(b: buffer, offset: number, value: number): number
buffer.writeuleb128(b: buffer, offset: number, value: number): number
```
Since other numbers in the buffer library have unsigned and signed implementations, it also makes sense to include both options for varints.
The functions take arguments similar to other read/write functions in the buffer library. However, they differ in that they return the amount of bytes that were read/written. In readleb128/readuleb128, this is the second return value. Having these functions return the count is necessary as it must be known in order for users to keep track of the buffer offset.
## Drawbacks
The only drawback known is a marginal increase in library complexity. However, the performance benefit from having library implementations of these functions outweighs the negligible change in complexity and is not a serious concern.