Skip to main content

Module buffer

Module buffer 

Source
Expand description

Opaque buffer handle for the Hurray C ABI.

HurrayBuffer is an opaque heap-allocated handle that wraps a hurray_core::BufferHandle together with the raw data pointer and an optional release callback. Callers create handles via hurray_buffer_from_ptr and MUST destroy them exactly once via hurray_buffer_destroy.

Structs§

HurrayBuffer
Opaque handle to a buffer registered with the Hurray C ABI.

Functions§

hurray_buffer_alignment⚠
Reads the declared alignment of a buffer handle (in bytes).
hurray_buffer_byte_size⚠
Reads the byte size of a buffer handle.
hurray_buffer_data_ptr⚠
Reads the raw data pointer stored in a buffer handle.
hurray_buffer_destroy⚠
Destroys a HurrayBuffer handle and invokes the release callback.
hurray_buffer_device_tag⚠
Reads the device tag wire byte of a buffer handle.
hurray_buffer_from_ptr⚠
Creates a new HurrayBuffer handle from a raw data pointer and metadata.
hurray_buffer_memory_class⚠
Reads the memory class wire byte of a buffer handle.
hurray_buffer_sync_mode⚠
Reads the sync mode wire byte of a buffer handle.

Type Aliases§

HurrayReleaseCallback
Optional release callback invoked by hurray_buffer_destroy.