Struct FunctionParam 

pub struct FunctionParam<X: Extension = NoExt> {
    pub mode: Option<FunctionParamMode>,
    pub name: Option<Ident>,
    pub data_type: DataType<X>,
    pub default: Option<Box<FunctionParamDefault<X>>>,
    pub meta: Meta,
}

One routine parameter: an optional argument mode (IN/OUT/INOUT/VARIADIC), an optional name, its type (b INT), and an optional default value (b INT DEFAULT 0 / b INT = 0).

The three lead-in facets are independent: a bare type (f(int)) leaves both mode and name unset, a mode may precede an unnamed type (f(OUT int)), and a named parameter may carry a default. The name is PostgreSQL’s param_name = type_function_name production (parsed with the type-name reservation set): a type_func_name keyword like left is a legal parameter name, a col_name keyword like int is not — so a lone int is unambiguously the type, mirroring how PostgreSQL resolves the name-vs-type ambiguity. The default is the PostgreSQL func_arg_with_default tail — boxed because it is usually absent and a FunctionParamDefault (an Expr) is comparatively large, so a default-less parameter pays only a null pointer (the ForeignKeyRef referential-action precedent). It is parameter metadata: an ordinary function-call argument is a FunctionArg on the unrelated call path and is unaffected.

Fields

mode: Option<FunctionParamMode>

Mode selected by this syntax.

name: Option<Ident>

Name referenced by this syntax.

data_type: DataType<X>

Data type named by this syntax.

default: Option<Box<FunctionParamDefault<X>>>

Optional default for this syntax.

meta: Meta

Source location and node identity.

Trait Implementations

impl<X: Clone + Extension> Clone for FunctionParam<X>

fn clone(&self) -> FunctionParam<X>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<X: Debug + Extension> Debug for FunctionParam<X>

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

Formats the value using the given formatter.

impl<'de, X> Deserialize<'de> for FunctionParam<X>

where X: Deserialize<'de> + Extension,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<X: Eq + Extension> Eq for FunctionParam<X>

impl<X: Hash + Extension> Hash for FunctionParam<X>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<X: PartialEq + Extension> PartialEq for FunctionParam<X>

fn eq(&self, other: &FunctionParam<X>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<X: Extension + Render> Render for FunctionParam<X>

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

Return the render for this value.

fn operand_binding_power(&self) -> Option<BindingPower>

The binding power this node contributes when it appears as an operand, or None (the default) for a self-delimiting node — an atom, call, or constructor — that never needs parentheses.

impl<X> Serialize for FunctionParam<X>

where X: Serialize + Extension,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<X: Extension> Spanned for FunctionParam<X>

fn span(&self) -> Span

Return the span for this value.

impl<X: PartialEq + Extension> StructuralPartialEq for FunctionParam<X>