Skip to main content

BufferUtil

Functions​

reader​

</>
BufferUtil.reader(buf: buffer | string) → BufferReader

Creates a BufferReader. The reader can be constructed from either a string or a buffer object. 

local reader = BufferUtil.reader()

writer​

</>
BufferUtil.writer(initialCapacity: number?) → BufferWriter

Creates a zero-initialized BufferWriter. An initial capacity can optionally be set, and is defaulted to 0. 

local writer = BufferUtil.writer()
Show raw api
{
    "functions": [
        {
            "name": "reader",
            "desc": "Creates a BufferReader. The reader can be constructed from either\na string or a `buffer` object.\n\n```lua\nlocal reader = BufferUtil.reader()\n```",
            "params": [
                {
                    "name": "buf",
                    "desc": "",
                    "lua_type": "buffer | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BufferReader"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "modules/buffer-util/init.luau"
            }
        },
        {
            "name": "writer",
            "desc": "Creates a zero-initialized BufferWriter. An initial capacity can\noptionally be set, and is defaulted to `0`.\n\n```lua\nlocal writer = BufferUtil.writer()\n```",
            "params": [
                {
                    "name": "initialCapacity",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BufferWriter"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "modules/buffer-util/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "BufferUtil",
    "desc": "",
    "source": {
        "line": 9,
        "path": "modules/buffer-util/init.luau"
    }
}