Skip to main content

FunctionBody

Enum FunctionBody 

Source
pub enum FunctionBody<X: Extension = NoExt> {
    Definition {
        definition: Literal,
        meta: Meta,
    },
    Return {
        expr: Box<Expr<X>>,
        meta: Meta,
    },
    Block {
        body: Box<Statement<X>>,
        meta: Meta,
    },
}
Expand description

The executable body of a CreateFunction routine — the body-representation axis.

Two body kinds are modelled today. Definition is an opaque source string introduced by the order-independent AS option (AS 'SELECT 1', AS $$ … $$, AS $body$ … $body$). Return is the SQL-standard live body RETURN <expr> (PostgreSQL 14+ / standard opt_routine_body), a real SQL Expr that rides the trailing CreateFunction::body slot — a distinct parse position from AS (the RETURN body strictly follows the whole option list, oracle-proven). This is a distinct enum — not a bare Literal field on FunctionOption::As — precisely so the live body reuses one body vocabulary across both slots rather than reshaping the option.

The axis is body kind (opaque string vs. live SQL), not quote style: a plain '…' and a dollar-quoted $tag$…$tag$ body are both LiteralKind::String and differ only in source spelling. That spelling — the delimiter tag and the verbatim body text — round-trips from the Literal’s span; it is recovered from source, never normalized, so a dollar body re-renders byte-for-byte.

The enum is generic over X because Return carries an Expr<X>; the Definition string variant is generic-free. A statement-list BEGIN ATOMIC … END body (PostgreSQL, oracle-accepted) shares the trailing slot and slots in here as a further variant carrying a routine-body statement list — deliberately deferred: modelling it honestly needs a routine-body statement grammar (its inner RETURN is not a top-level Statement), which is a separate surface from this single-Expr body.

Variants§

§

Definition

AS <string> — an opaque routine body in the target language, kept as the source Literal (plain-quoted or dollar-quoted) rather than re-parsed, because the body’s grammar is the target language, not SQL.

Fields

§definition: Literal

Definition text supplied by this syntax.

§meta: Meta

Source location and node identity.

§

Return

RETURN <expr> — the SQL-standard live expression body (opt_routine_body’s ReturnStmt). The Expr is boxed (the MacroBody precedent) so the common AS string body pays no Expr footprint on the shared FunctionOption::As path.

Fields

§expr: Box<Expr<X>>

Expression evaluated by this syntax.

§meta: Meta

Source location and node identity.

§

Block

A MySQL SQL/PSM routine body — one routine_body statement, usually the BEGIN … END compound block (Statement::Compound) but any single body statement (a bare SET, a flow-control construct, a RETURN). This is the live statement-list body the FunctionBody axis doc anticipated; it rides the trailing CreateFunction::body slot exactly as Return does — a distinct grammatical position after the whole characteristic list. Boxed (Statement is large) so the common AS-string path pays no footprint.

Fields

§body: Box<Statement<X>>

The routine body statement (typically a compound block); parsed through the parse_body_statement seam so its inner grammar is the MySQL body sub-language.

§meta: Meta

Source location and node identity.

Trait Implementations§

Source§

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

Source§

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

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<X: Debug + Extension> Debug for FunctionBody<X>

Source§

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

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

impl<'de, X> Deserialize<'de> for FunctionBody<X>
where X: Deserialize<'de> + Extension,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

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

Source§

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

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

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

Inequality operator !=. Read more
Source§

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

Source§

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

Return the render for this value.
Source§

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. Read more
Source§

impl<X> Serialize for FunctionBody<X>
where X: Serialize + Extension,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

fn span(&self) -> Span

Return the span for this value.
Source§

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

Auto Trait Implementations§

§

impl<X> Freeze for FunctionBody<X>

§

impl<X> RefUnwindSafe for FunctionBody<X>
where X: RefUnwindSafe,

§

impl<X> Send for FunctionBody<X>
where X: Send,

§

impl<X> Sync for FunctionBody<X>
where X: Sync,

§

impl<X> Unpin for FunctionBody<X>

§

impl<X> UnsafeUnpin for FunctionBody<X>

§

impl<X> UnwindSafe for FunctionBody<X>
where X: UnwindSafe,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynAstExt for T
where T: Extension + Render + 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Erase to &dyn Any for downcasting a node back to its concrete type.
Source§

fn dyn_clone(&self) -> Box<dyn DynAstExt>

Clone into a fresh box — the object-safe stand-in for Clone (whose Self-returning signature cannot go through a vtable).
Source§

fn dyn_eq(&self, other: &dyn DynAstExt) -> bool

Structural equality against another erased node — the object-safe stand-in for PartialEq (whose &Self argument cannot go through a vtable). Equal iff other holds the same concrete type and that type deems the values equal; differently-typed nodes are never equal.
Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feed this node’s hash into an erased hasher — the object-safe stand-in for Hash::hash (whose generic H: Hasher cannot go through a vtable).
Source§

impl<T> Extension for T
where T: Clone + Debug + Eq + Hash + Spanned,

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> RenderExt for T
where T: Render,

Source§

fn displayed<'a>(&'a self, ctx: &'a RenderCtx<'a>) -> Displayed<'a, T>

Pair this node with an explicit canonical RenderCtx so format!, to_string, and {} render it. This is the canonical path: the ctx’s resolver and source must match the node’s parse.
Source§

fn debug_sql<'a>(&'a self, resolver: &'a dyn Resolver) -> DebugSql<'a, Self>
where Self: Sized,

Render this node for debugging against an explicitly-supplied resolver (the debug-SQL mitigation), returning a Display adapter. Read more
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.