summaryrefslogtreecommitdiff
path: root/meta
diff options
context:
space:
mode:
authorfesily <fesil@foxmail.com>2022-08-13 14:25:05 +0800
committerfesily <fesil@foxmail.com>2022-08-13 14:25:05 +0800
commite0d3fc827071e6cce8e92b2a8c8fe5b706d1e987 (patch)
treebaac4aca4fbce948aedf027c7493338698287184 /meta
parentdacf711d57cddbf106937abd64f544a9298f3349 (diff)
downloadlua-language-server-e0d3fc827071e6cce8e92b2a8c8fe5b706d1e987.zip
move string.buffer to buildin
Diffstat (limited to 'meta')
-rw-r--r--meta/template/string.buffer.lua (renamed from meta/3rd/OpenResty/library/string/buffer.lua)10
1 files changed, 6 insertions, 4 deletions
diff --git a/meta/3rd/OpenResty/library/string/buffer.lua b/meta/template/string.buffer.lua
index 70ecc6d8..ee57a1ad 100644
--- a/meta/3rd/OpenResty/library/string/buffer.lua
+++ b/meta/template/string.buffer.lua
@@ -1,6 +1,7 @@
+---#if not JIT then DISABLE() end
---@meta
-
+---@version JIT
--- The string buffer library allows high-performance manipulation of string-like data.
---
--- Unlike Lua strings, which are constants, string buffers are mutable sequences of 8-bit (binary-transparent) characters. Data can be stored, formatted and encoded into a string buffer and later converted, extracted or decoded.
@@ -10,7 +11,7 @@
--- The string buffer libary also includes a high-performance serializer for Lua objects.
---
---
----## Streaming Serialization
+--- ## Streaming Serialization
---
--- In some contexts, it's desirable to do piecewise serialization of large datasets, also known as streaming.
---
@@ -88,7 +89,7 @@
--- 0x1fe0.. → 0xff n.I
--- ```
---
----## Error handling
+--- ## Error handling
---
--- Many of the buffer methods can throw an error. Out-of-memory or usage errors are best caught with an outer wrapper for larger parts of code. There's not much one can do after that, anyway.
---
@@ -101,7 +102,7 @@
--- end
--- ```
---
----## FFI caveats
+--- ## FFI caveats
---
--- The string buffer library has been designed to work well together with the FFI library. But due to the low-level nature of the FFI library, some care needs to be taken:
---
@@ -126,6 +127,7 @@ local buffer = {}
---
--- The maximum size of a single buffer is the same as the maximum size of a Lua string, which is slightly below two gigabytes. For huge data sizes, neither strings nor buffers are the right data structure — use the FFI library to directly map memory or files up to the virtual memory limit of your OS.
---
+---@version JIT
---@class string.buffer : table
local buf = {}