Skip to content
Discord Luau

Buffer

Internal FFI interoperability helpers for the Opus package. Wraps stdPolyfills.ffi into named operations so higher-level modules never interact with it directly.

Summary

Functions

Buffer.alloc(size: number) → FFIPointerBuffer.dupe(source: buffer) → FFIPointerBuffer.free(pointer: FFIPointer)Buffer.read(pointer: FFIPointer, length: number) → bufferBuffer.getNull() → FFIPointerBuffer.fromCString(pointer: FFIPointer, maxLength: number) → string

Functions

Section titled “Functions”

alloc

Section titled “alloc”
Buffer . alloc ( size )  -> FFIPointer

Parameters

size: number

Returns

FFIPointer

dupe

Section titled “dupe”
Buffer . dupe ( source )  -> FFIPointer

Parameters

source: buffer

Returns

FFIPointer

free

Section titled “free”
Buffer . free ( pointer )  -> ()

Parameters

pointer: FFIPointer

read

Section titled “read”
Buffer . read ( pointer ,  length )  -> buffer

Reads length bytes from pointer into a freshly created Luau buffer.

Parameters

pointer: FFIPointer
length: number

Returns

buffer

getNull

Section titled “getNull”
Buffer . getNull ( )  -> FFIPointer

Returns a null FFI pointer for optional pointer arguments.

Returns

FFIPointer

fromCString

Section titled “fromCString”
Buffer . fromCString ( pointer ,  maxLength )  -> string

Reads a null-terminated C string from an FFI pointer into a Luau string, up to maxLength bytes.

Parameters

pointer: FFIPointer
maxLength: number

Returns

string