Struct FunctionMeta

pub struct FunctionMeta(/* private fields */);

The metadata for a function

Implementations

impl FunctionMeta

pub fn fields_iter(&self) -> FieldIterator

Iterator over the fields in this function

pub fn get_name(&self) -> String

Gets the name of the function.

pub fn full_name(&self) -> String

Gets the full name of the function. The full name includes the function’s name and the function’s signature: “name(type1 type2.. typeN)”.

pub fn body(&self) -> String

Gets the body of the function.

pub fn language(&self) -> String

Gets the language of the function.

pub fn called_on_null_input(&self) -> bool

Gets whether a function is called on “null”.

pub fn argument_count(&self) -> usize

Gets the number of arguments this function takes.

pub fn argument(&self, index: usize) -> Result<()>

Gets the function’s argument name and type for the provided index.

pub fn argument_type_by_name(&self, name: &str) -> ConstDataType

Gets the function’s argument and type for the provided name.

pub fn return_type(&self) -> ConstDataType

Gets the return type of the function.

pub fn field_by_name(&self, name: &str) -> Value

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying “functions” metadata table.

Trait Implementations

impl Debug for FunctionMeta

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

Formats the value using the given formatter.