Struct FunctionFlags 

pub struct FunctionFlags {
    pub direct_only: bool,
    pub innocuous: bool,
    pub deterministic: bool,
}

What a registered function promises about itself.

It lives here, below inillucent-ext, because two different layers have to read the same promise: inillucent_ext::registry::Registry records it when an application registers a function, and the binder enforces it when a schema names one. inillucent-ext re-exports this type, so a registrant writes inillucent_ext::registry::FunctionFlags exactly as before.

Fields

direct_only: bool

The function may only be called from top-level SQL, never from a schema: not from a DEFAULT, a CHECK, a generated column, an index expression, a partial-index predicate, a view or a trigger.

FunctionFlags::external sets this, because the safe assumption about code somebody else wrote is that it does something. It is not what the Default derive gives, which is every flag false: a registrant who writes ..FunctionFlags::default() gets a function a schema may name. That is the hole embed was registered through (task-1969, 7.4), and inillucent_ext::registry::UserFunction::external is the constructor to reach for instead.

innocuous: bool

The function does nothing an ordinary expression could not: no side effects, no file access, no dependence on anything but its arguments.

deterministic: bool

The function returns the same answer for the same arguments within one statement, so the planner may call it once.

Implementations

impl FunctionFlags

pub fn builtin() -> FunctionFlags

Returns the flags a built-in carries: safe for a schema to call.

pub fn external() -> FunctionFlags

Returns the flags anything registered from outside carries by default.

Trait Implementations

impl Clone for FunctionFlags

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FunctionFlags

impl Debug for FunctionFlags

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

Formats the value using the given formatter.

impl Default for FunctionFlags

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FunctionFlags

impl PartialEq for FunctionFlags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FunctionFlags