Struct PgFunction 

pub struct PgFunction {
    pub schema: String,
    pub name: String,
    pub in_types: Vec<String>,
    pub in_names: Vec<Option<String>>,
    pub out_columns: Vec<OutColumn>,
    pub returns_set: bool,
    pub volatility: String,
    pub language: String,
    pub source: String,
}

One overload of a PostgreSQL function, reduced to what the mutation-contract check needs: the input arguments (in positional call order, excluding OUT/TABLE columns) and the output columns.

Fields

schema: String

Schema the function lives in.

name: String

Function name (unqualified).

in_types: Vec<String>

Input argument types in call order (format_type), modes IN/INOUT/ VARIADIC only — these are the positions the server binds.

in_names: Vec<Option<String>>

Input argument names in call order; None for unnamed positions.

out_columns: Vec<OutColumn>

Output columns of the result row (see OutColumn). Empty when the function returns a scalar / record the catalog cannot expand.

returns_set: bool

Whether the function returns a set (RETURNS SETOF … / RETURNS TABLE(…)). A function a query reads from must.

volatility: String

pg_proc.provolatile: "i" (IMMUTABLE), "s" (STABLE) or "v" (VOLATILE). A function a query reads from may not be VOLATILE: a read may be cached, retried or served from a replica, and none of those is safe for a function that writes.

language: String

Implementation language (pg_language.lanname, e.g. plpgsql, sql, c). The payload-key consumption scan (#384) only reads plpgsql/sql bodies — for other languages source is a symbol, not scannable text.

source: String

Function body (pg_proc.prosrc). For plpgsql/sql functions this is the actual source text.

Trait Implementations

impl Clone for PgFunction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgFunction

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

Formats the value using the given formatter.

impl Eq for PgFunction

impl PartialEq for PgFunction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PgFunction