Struct Function 

pub struct Function {

    pub oid: u32,
    pub name: String,
    pub namespace: u32,
    pub owner: u32,
    pub lang: u32,
    pub cost: f32,
    pub rows: u32,
    pub support: u32,
    pub kind: u8,
    pub strict: bool,
    pub leakproof: bool,
    pub volatile: u8,
    pub parallel: u8,
    pub rettype: u32,
    pub retset: bool,
    pub argtypes: Vec<u32>,
    pub allargtypes: Vec<u32>,
    pub argmodes: Vec<u8>,
    pub argnames: Vec<String>,
    pub argdefaults: Option<String>,
    pub nargdefaults: i16,
    pub src: String,
    pub bin: String,
    pub body: Option<FunctionBody>,
    pub config: Vec<String>,
    pub secdef: bool,
}

A function, one row of pg_proc: a function of the setup of a new cluster, such as a function in SQL of information_schema, or a function that CREATE FUNCTION makes.

Fields

oid: u32

The OID. Catalog::create_function sets it.

name: String

The name.

namespace: u32

The OID of the schema.

owner: u32

The OID of the owner role.

lang: u32

prolang: the OID of the language.

cost: f32

procost: the cost in units of cpu_operator_cost, a positive number.

rows: u32

prorows: the number of rows of a function that returns a set, or 0.

support: u32

prosupport: the OID of the support function, or 0.

kind: u8

prokind: f for a function, p for a procedure or a for an aggregate.

strict: bool

proisstrict: true when a null argument gives null without a call.

leakproof: bool

proleakproof: true when the function has no side effects and gives no information about its arguments other than its result.

volatile: u8

provolatile: i immutable, s stable or v volatile.

parallel: u8

proparallel: s safe, r restricted or u unsafe.

rettype: u32

prorettype: the OID of the result type.

retset: bool

proretset: true when the function returns a set.

argtypes: Vec<u32>

proargtypes: the types of the input arguments.

allargtypes: Vec<u32>

proallargtypes: the types of all the arguments, with the OUT arguments. The list is empty when all the arguments are input arguments.

argmodes: Vec<u8>

proargmodes: the mode of each argument, i, o, b or t. The list is empty when all the arguments are input arguments.

argnames: Vec<String>

proargnames: the name of each argument, with an empty name for an argument without a name. The list is empty when no argument has a name.

argdefaults: Option<String>

proargdefaults: the defaults of the last input arguments, in the stored form of a list of expressions, or None when no argument has a default.

nargdefaults: i16

pronargdefaults: the number of the defaults in argdefaults.

src: String

prosrc: the body in a string, or empty for a body in SQL.

bin: String

probin: the file of a function in C, or empty for another function.

body: Option<FunctionBody>

The text of the statement that made the function, or None.

config: Vec<String>

proconfig: the settings that apply during a call, each one as name=value, with the name of the parameter as PostgreSQL spells it.

secdef: bool

prosecdef: true for SECURITY DEFINER, which runs the function as its owner.

Trait Implementations

impl Clone for Function

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 Function

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

Formats the value using the given formatter.

impl Eq for Function

impl PartialEq for Function

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Function