pgrx_pg_sys

Function heap_tuple_get_struct

Source
pub unsafe fn heap_tuple_get_struct<T>(htup: HeapTuple) -> *mut T
Expand description

Retrieve the “user data” of the specified pg_sys::HeapTuple as a specific type. Typically this will be a struct that represents a Postgres system catalog, such as FormData_pg_class.

§Returns

A pointer to the pg_sys::HeapTuple’s “user data”, cast as a mutable pointer to T. If the specified htup pointer is null, the null pointer is returned.

§Safety

This function cannot verify that the specified htup points to a valid pg_sys::HeapTuple nor that if it does, that its bytes are bitwise compatible with T.