Buffer
Internal FFI interoperability helpers for the Dave package.
Summary
Functions
Buffer.toCString(value: string) → FFIPointerBuffer.fromCString(pointer: FFIPointer) → stringBuffer.allocateSlot() → FFIPointerBuffer.readRawU64(value: buffer) → numberBuffer.readSizeT(slot: FFIPointer) → numberBuffer.readU64AtOffset(pointer: FFIPointer, offset: number) → numberBuffer.adopt(pointer: FFIPointer, handleType: FFIPointerType?) → FFIPointer?Buffer.readLibBytes(dataSlot: FFIPointer, lengthSlot: FFIPointer) → bufferBuffer.u64StringToBuffer(decimal: string) → bufferBuffer.bufferToU64String(bytes: buffer) → stringBuffer.bufferToHex(bytes: buffer) → stringBuffer.readPointerBytes(pointer: FFIPointer, lengthValue: any) → bufferBuffer.readU64ArrayAndFree(pointerSlot: FFIPointer, lengthSlot: FFIPointer) → { string }Buffer.withCStringArray(ids: { string }, callback: (pointer: FFIPointer, count: number) -> ())Functions
Section titled “Functions”toCString
Section titled “toCString”Buffer . toCString ( value ) -> FFIPointer
Parameters
| value: string |
Returns
| FFIPointer |
fromCString
Section titled “fromCString”Buffer . fromCString ( pointer ) -> string
Parameters
| pointer: FFIPointer |
Returns
| string |
allocateSlot
Section titled “allocateSlot”Buffer . allocateSlot ( ) -> FFIPointer
Returns
| FFIPointer |
readRawU64
Section titled “readRawU64”Buffer . readRawU64 ( value ) -> number
Reads a u64 as Zune hands it over (an 8-byte little-endian buffer, from a native return or readu64) as a number.
Parameters
| value: buffer |
Returns
| number |
readSizeT
Section titled “readSizeT”Buffer . readSizeT ( slot ) -> number
Parameters
| slot: FFIPointer |
Returns
| number |
readU64AtOffset
Section titled “readU64AtOffset”Buffer . readU64AtOffset ( pointer , offset ) -> number
Buffer . adopt ( pointer , handleType ) -> FFIPointer?
Makes a pointer libdave handed back, as a return value or through an out slot, safe to use. Returns nil for NULL
and leaves it untagged, because Zune shares one null object between every library in the process. Otherwise it
sets the pointer's tag to handleType's, or clears it for raw memory: Zune keeps one object per address, and an
address libdave freed and handed out again still carries the tag of whatever lived there before.
Parameters
| pointer: FFIPointer | |
| handleType: FFIPointerType? |
Returns
| FFIPointer? |
readLibBytes
Section titled “readLibBytes”Buffer . readLibBytes ( dataSlot , lengthSlot ) -> buffer
Parameters
| dataSlot: FFIPointer | |
| lengthSlot: FFIPointer |
Returns
| buffer |
u64StringToBuffer
Section titled “u64StringToBuffer”Buffer . u64StringToBuffer ( decimal ) -> buffer
Parameters
| decimal: string |
Returns
| buffer |
bufferToU64String
Section titled “bufferToU64String”Buffer . bufferToU64String ( bytes ) -> string
Parameters
| bytes: buffer |
Returns
| string |
bufferToHex
Section titled “bufferToHex”Buffer . bufferToHex ( bytes ) -> string
Parameters
| bytes: buffer |
Returns
| string |
readPointerBytes
Section titled “readPointerBytes”Buffer . readPointerBytes ( pointer , lengthValue ) -> buffer
Parameters
| pointer: FFIPointer | |
| lengthValue: any |
Returns
| buffer |
readU64ArrayAndFree
Section titled “readU64ArrayAndFree”Buffer . readU64ArrayAndFree ( pointerSlot , lengthSlot ) -> { string }
Parameters
| pointerSlot: FFIPointer | |
| lengthSlot: FFIPointer |
Returns
| { string } |
withCStringArray
Section titled “withCStringArray”Buffer . withCStringArray ( ids , callback ) -> ()
Parameters
| ids: { string } | |
| callback: (pointer: FFIPointer, count: number) -> () |