Skip to main content

FunctionOption

squonk_ast::ast

Enum FunctionOption 

Source 
pub enum FunctionOption<X: Extension = NoExt> {
    Language {
        name: LanguageName,
        meta: Meta,
    },
    As {
        body: FunctionBody<X>,
        meta: Meta,
    },
    NullBehavior {
        behavior: FunctionNullBehavior,
        meta: Meta,
    },
    Deterministic {
        not: bool,
        meta: Meta,
    },
    DataAccess {
        access: SqlDataAccess,
        meta: Meta,
    },
    SqlSecurity {
        context: SqlSecurityContext,
        meta: Meta,
    },
    Comment {
        comment: Literal,
        meta: Meta,
    },
}
Expand description

The SQL function option forms represented by the AST.

Variants§

§

Language

A LANGUAGE <name> clause naming the routine’s implementation language. The name is a NonReservedWord_or_Sconst (LanguageName) — a bare word or, on the PostgreSQL surface, an Sconst string (LANGUAGE 'sql'/E'sql'/$$sql$$) — shared with the DoArg::Language argument.

Fields

§name: LanguageName

Name referenced by this syntax.

§meta: Meta

Source location and node identity.

§

As

AS <body> — the string routine body, carried on the FunctionBody axis. The AS option only ever homes an opaque source string (plain '…' or dollar-quoted $tag$…$tag$), i.e. FunctionBody::Definition; the live RETURN <expr> body rides the trailing CreateFunction::body slot, a disjoint grammatical position.

Fields

§body: FunctionBody<X>

The routine’s string body; see FunctionBody.

§meta: Meta

Source location and node identity.

§

NullBehavior

The null-call behaviour (CALLED ON NULL INPUT / RETURNS NULL ON NULL INPUT / STRICT).

Fields

§behavior: FunctionNullBehavior

The null-input behaviour; see FunctionNullBehavior.

§meta: Meta

Source location and node identity.

§

Deterministic

The MySQL [NOT] DETERMINISTIC routine characteristic — whether the routine always produces the same result for the same inputs. The not field records the negated spelling so NOT DETERMINISTIC round-trips distinctly from a routine that simply omits the characteristic. A stored-routine option (MySQL SQL/PSM), not a PostgreSQL CREATE FUNCTION clause.

Fields

§not: bool

Whether the NOT prefix was written (NOT DETERMINISTIC).

§meta: Meta

Source location and node identity.

§

DataAccess

The MySQL SQL-data-access routine characteristic (CONTAINS SQL / NO SQL / READS SQL DATA / MODIFIES SQL DATA) — the advisory declaration of how the routine body touches data.

Fields

§access: SqlDataAccess

Which data-access class was written; see SqlDataAccess.

§meta: Meta

Source location and node identity.

§

SqlSecurity

The MySQL SQL SECURITY {DEFINER | INVOKER} routine characteristic — the privilege context the routine executes under.

Fields

§context: SqlSecurityContext

The security context; see SqlSecurityContext.

§meta: Meta

Source location and node identity.

§

Comment

The MySQL COMMENT '<string>' routine characteristic — a stored descriptive comment. The PostgreSQL comment surface is the separate COMMENT ON FUNCTION statement, so this inline option is MySQL-only.

Fields

§comment: Literal

The comment string literal.

§meta: Meta

Source location and node identity.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> FunctionOption<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 FunctionOption<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 FunctionOption<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 FunctionOption<X>

Source§

impl<X: Hash + Extension> Hash for FunctionOption<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 FunctionOption<X>

Source§

fn eq(&self, other: &FunctionOption<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 FunctionOption<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 FunctionOption<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 FunctionOption<X>

Source§

fn span(&self) -> Span

Return the span for this value.
Source§

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

Auto Trait Implementations§

§

impl<X> Freeze for FunctionOption<X>

§

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

§

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

§

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

§

impl<X> Unpin for FunctionOption<X>

§

impl<X> UnsafeUnpin for FunctionOption<X>

§

impl<X> UnwindSafe for FunctionOption<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.