BufferStream

Methods

read


:read(amount: number?): buffer
:read(amount: number?, bytes: true?): buffer
:read(amount: number?, bytes: false): string
:read(amount: number?, bytes: boolean?): string | buffer

Parameters

amount: number? - The amount of bytes to read, if not provided, it will read until EOF or luau limit.
bytes: true? | false | boolean? - If false, the function will return a string instead of a buffer.
- default: true

Throws

Reader Error

write


:write(data: string | buffer): ()

Parameters

data: string | buffer - The data to write to the stream.

Throws

Writer Error

pos


:pos(): number

size


:size(): number

seekTo


:seekTo(pos: number): ()

Parameters

pos: number - The position to seek to.

seekBy


:seekBy(offset: number): ()

Parameters

offset: number - The offset to seek by.

canRead


:canRead(amount: number?): boolean

Parameters

amount: number? - The amount of bytes to check for reading availability.
- default: 0

writer


:writer(): IoWritable

Throws

Memory Error

reader


:reader(): IoReadable

Throws

Memory Error