Struct Routine 

pub struct Routine {

    pub schema: String,
    pub name: String,
    pub description: Option<String>,
    pub params: Vec<RoutineParam>,
    pub return_type: RetType,
    pub returns_composite: bool,
    pub volatility: FuncVolatility,
    pub has_variadic: bool,
    pub isolation_level: Option<String>,
    pub settings: Vec<(String, String)>,
    pub is_procedure: bool,
    pub media_type: Option<String>,
    pub media_base_type: Option<String>,
    pub output_columns: Vec<(String, String)>,
}

A stored function or procedure.

Fields

schema: String

Schema name

name: String

Function name

description: Option<String>

Description from comment

params: Vec<RoutineParam>

Function parameters

return_type: RetType

Return type

returns_composite: bool

Whether the return type is composite (a row type or record), meaning SELECT * FROM fn() expands to the type’s own columns rather than a single column named after the function.

volatility: FuncVolatility

Function volatility

has_variadic: bool

Whether the function has VARIADIC parameters

isolation_level: Option<String>

Isolation level (if set by function)

settings: Vec<(String, String)>

Function-level GUC settings

is_procedure: bool

Whether this is a procedure (vs function)

media_type: Option<String>

The media type this function’s value already is.

A domain named image/png is a declaration about the value, not a type the API layer serialises: returns "text/plain" returns text, and wrapping it in JSON would be answering a question nobody asked. */* is spelled that way in the catalogue and reaches a client as application/octet-stream, which is what “some bytes” is called on the wire.

media_base_type: Option<String>

The type that media-type domain is a domain over.

A bytea renders as \x followed by hex when this side cannot name its type, and that rendering is a description of the bytes rather than the bytes. See Self::media_type.

output_columns: Vec<(String, String)>

The columns a RETURNS TABLE function’s rows have, as (name, type).

A function returning rows of a table is shaped by that table, whose columns are known. One declaring its own columns is not, and this is the only account of them – without it the result can only be selected with *, and a column of a type this process cannot decode comes back null with nothing to say it should have been rendered by the database.

Implementations

impl Routine

pub fn produced_media_type(&self) -> Option<&str>

The media type this function produces, as a client would name it.

impl Routine

pub fn qualified_identifier(&self) -> QualifiedIdentifier

Get the qualified identifier for this routine.

pub fn is_safe_for_get(&self) -> bool

Check if this function is safe for GET requests.

pub fn required_params(&self) -> impl Iterator<Item = &RoutineParam>

Get required parameters (no default).

pub fn find_param(&self, name: &str) -> Option<&RoutineParam>

Find a parameter by name.

Trait Implementations

impl Clone for Routine

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 Routine

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Routine

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Routine

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.