Module pgx::fcinfo

Helper functions for creating Postgres UDFs

Typically these functions are not necessary to call directly as they’re used behind the scenes by the code generated by the #[pg_extern] macro.

Structs

• NULL
  The equivalent of a PostgreSQL NULL

Functions

• direct_function_call^⚠
  This mimics the functionality of Postgres’ DirectFunctionCall macros, allowing you to call internal Postgres functions using its “V1” calling convention. Unlike the Postgres’ C macros, the function is allowed to return a NULL datum.
• direct_function_call_as_datum^⚠
  Same as direct_function_call but instead returns the direct Option<pg_sys::Datum> instead of converting it to a value
• direct_pg_extern_function_call^⚠
  Akin to direct_function_call, but specifically for calling those functions declared with the #[pg_extern] attribute.
• direct_pg_extern_function_call_as_datum^⚠
  Same as direct_pg_extern_function_call but instead returns the direct Option<pg_sys::Datum> instead of converting it to a value
• pg_arg_is_null^⚠
  Is the specified argument for a PG_FUNCTION_INFO_V1 function NULL?
• pg_func_extra^⚠
  Retrieve the .flinfo.fn_extra pointer (as a PgBox’d type) from pg_sys::FunctionCallInfo.
• pg_getarg^⚠
  Get a numbered argument for a PG_FUNCTION_INFO_V1 function as the specified Rust type.
• pg_getarg_cstr^⚠
  This is intended for Postgres functions that take an actual cstring argument, not for getting a varlena argument type as a CStr.
• pg_getarg_datum^⚠
  Get a numbered argument for a PG_FUNCTION_INFO_V1 function as an Option containing a pg_sys::Datum.
• pg_getarg_datum_raw^⚠
  Get a numbered argument for a PG_FUNCTION_INFO_V1 function as a raw pg_sys::Datum.
• pg_getarg_pointer^⚠
  Get a numbered argument for a PG_FUNCTION_INFO_V1 function as raw pointer to a Rust type T.
• pg_getarg_type^⚠
  Safety
• pg_return_null^⚠
  Modifies the specified fcinfo struct to indicate that its return value is null.
• pg_return_void^⚠
  Indicates that a PG_FUNCTION_INFO_V1 function is returning a SQL “void”.
• srf_first_call_init^⚠
• srf_is_first_call^⚠
• srf_per_call_setup^⚠
• srf_return_done^⚠
• srf_return_next^⚠