Struct Internal

pub struct Internal(/* private fields */);

Represents Postgres’ internal data type, which is documented as:

The internal pseudo-type is used to declare functions that are meant only to be called internally by the database system, and not by direct invocation in an SQL query. If a function has at least one internal-type argument then it cannot be called from SQL. To preserve the type safety of this restriction it is important to follow this coding rule: do not create any function that is declared to return internal unless it has at least one internal argument.

Implementation Notes

Internal is a wrapper around an Option<pg_sys::Datum>, which when retrieved via ::get/get_mut() is cast to a pointer of T, returning the respective reference.

Safety

We make no guarantees about what the internal pg_sys::Datum actually points to in memory, so it is your responsibility to ensure that what you’re casting it to is really what it is.

Implementations

impl Internal

pub fn new<T>(t: T) -> Self

Construct a new Internal from any type.

The value will be dropped when the PgMemoryContexts::CurrentMemoryContext is deleted.

pub fn initialized(&self) -> bool

Returns true if the internal value is initialized. If false, this is a null pointer.

pub unsafe fn get<T>(&self) -> Option<&T>

Return a reference to the memory pointed to by this Internal, as Some(&T), unless the backing datum is null, then None.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub unsafe fn insert<T>(&mut self, value: T) -> &mut T

Initializes the internal with value, then returns a mutable reference to it.

If the Internal is already initialized with a value, the old value is dropped.

See also Internal::get_or_insert, which doesn’t update the value if already initialized.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub unsafe fn get_mut<T>(&self) -> Option<&mut T>

Return a reference to the memory pointed to by this Internal, as Some(&mut T), unless the backing datum is null, then None.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub unsafe fn get_or_insert<T>(&mut self, value: T) -> &mut T

Initializes the internal with value if it is not initialized, then returns a mutable reference to the contained value.

See also Internal::insert, which updates the value even if the option already contains Some.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub unsafe fn get_or_insert_default<T>(&mut self) -> &mut T

where T: Default,

Initializes the internal with a default if it is not initialized, then returns a mutable reference to the contained value.

See also Internal::insert, which updates the value even if the option already contains Some.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub unsafe fn get_or_insert_with<F, T>(&mut self, f: F) -> &mut T

where F: FnOnce() -> T,

Inserts a value computed from f into the internal if it is None, then returns a mutable reference to the contained value.

Safety

We cannot guarantee that the contained datum points to memory that is really T. This is your responsibility.

pub fn unwrap(self) -> Option<Datum>

Returns the contained Option<pg_sys::Datum>

Trait Implementations

impl<'fcx> ArgAbi<'fcx> for Internal

unsafe fn unbox_arg_unchecked(arg: Arg<'_, 'fcx>) -> Self

Unbox an argument with a matching type.

unsafe fn unbox_nullable_arg(arg: Arg<'_, 'fcx>) -> Nullable<Self>

Unbox a nullable arg

fn is_virtual_arg() -> bool

“Is this a virtual arg?”

impl BoxRet for Internal

unsafe fn box_into<'fcx>(self, fcinfo: &mut FcInfo<'fcx>) -> Datum<'fcx>

Safety

impl Default for Internal

fn default() -> Internal

Returns the “default value” for a type.

impl From<Option<Datum>> for Internal

fn from(datum: Option<Datum>) -> Self

Converts to this type from the input type.

impl FromDatum for Internal

unsafe fn from_polymorphic_datum( datum: Datum, is_null: bool, _: Oid, ) -> Option<Internal>

Like from_datum for instantiating polymorphic types which require preserving the dynamic type metadata.

const GET_TYPOID: bool = false

Should a type OID be fetched when calling from_datum?

unsafe fn from_datum(datum: Datum, is_null: bool) -> Option<Self>

Safety

unsafe fn from_datum_in_memory_context( memory_context: PgMemoryContexts, datum: Datum, is_null: bool, typoid: Oid, ) -> Option<Self>

Default implementation switched to the specified memory context and then simply calls FromDatum::from_datum(...) from within that context.

unsafe fn try_from_datum( datum: Datum, is_null: bool, type_oid: Oid, ) -> Result<Option<Self>, TryFromDatumError>

where Self: IntoDatum,

try_from_datum is a convenience wrapper around FromDatum::from_datum that returns a a Result around an Option, as a Datum can be null. It’s intended to be used in situations where the caller needs to know whether the type conversion succeeded or failed.

unsafe fn try_from_datum_in_memory_context( memory_context: PgMemoryContexts, datum: Datum, is_null: bool, type_oid: Oid, ) -> Result<Option<Self>, TryFromDatumError>

where Self: IntoDatum,

A version of try_from_datum that switches to the given context to convert from Datum

impl IntoDatum for Internal

fn into_datum(self) -> Option<Datum>

fn type_oid() -> Oid

fn composite_type_oid(&self) -> Option<Oid>

fn is_compatible_with(other: Oid) -> bool

Is a Datum of this type compatible with another Postgres type?

impl SqlTranslatable for Internal

fn argument_sql() -> Result<SqlMapping, ArgumentError>

fn return_sql() -> Result<Returns, ReturnsError>

fn optional() -> bool

fn type_name() -> &'static str

fn variadic() -> bool

fn entity() -> FunctionMetadataTypeEntity