Skip to main content

FunctionDef

Struct FunctionDef 

Source
pub struct FunctionDef {
Show 14 fields pub name: String, pub args_repr: String, pub returns: String, pub language: String, pub body: String, pub owner: Option<String>, pub acl: Vec<AclItem>, pub volatility: u8, pub strict: bool, pub security_definer: bool, pub leakproof: bool, pub parallel: u8, pub cost: Option<f64>, pub rows: Option<f64>,
}
Expand description

v7.12.4 — catalogued user-defined function. body is the raw source text between $$ ... $$; the engine re-parses it on invocation. This keeps the storage codec stable when the PL/pgSQL surface grows (no breaking-change risk on the disk format).

Fields§

§name: String§args_repr: String

Display form of the argument list, e.g. "(name TEXT, ts TIMESTAMP)". Empty "()" for the trigger function shape. Parser-side canonicalised before storage.

§returns: String

Display form of the return type, e.g. "TRIGGER" / "INT" / "SETOF text". The engine special-cases "TRIGGER" (case-insensitive) to gate trigger-only semantics (NEW/OLD).

§language: String

LANGUAGE clause, lowercased. "plpgsql" / "sql".

§body: String

Source body of the function. PL/pgSQL: includes the surrounding BEGIN ... END;. SQL: includes the statement(s). The engine re-parses on invocation; bad bodies surface as a parse error at CALL time, not CREATE.

§owner: Option<String>

v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.

§acl: Vec<AclItem>

v7.39 (read01 round 61) — explicit GRANTs (PG pg_proc.proacl). EMPTY is NOT “nobody may call it”: PG grants EXECUTE to PUBLIC by default, and leaves proacl NULL to say so. The list materialises on the first GRANT / REVOKE.

§volatility: u8

v7.39 (round 322, V46) — IMMUTABLE / STRICT / PARALLEL SAFE / SECURITY DEFINER / LEAKPROOF / COST / ROWS. strict is the only one with execution semantics today (a NULL argument yields a NULL result without running the body); the rest are recorded so pg_get_functiondef and pg_proc report what was declared.

§strict: bool§security_definer: bool§leakproof: bool§parallel: u8§cost: Option<f64>§rows: Option<f64>

Trait Implementations§

Source§

impl Clone for FunctionDef

Source§

fn clone(&self) -> FunctionDef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FunctionDef

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FunctionDef

Source§

fn eq(&self, other: &FunctionDef) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FunctionDef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.