Struct DialectFunction 

pub struct DialectFunction {
    pub metadata: Map<String, Value>,
    pub name: String,
    pub required_options: Map<String, Value>,
    pub source: String,
    pub supported_impls: Vec<String>,
    pub system_metadata: Option<SystemFunctionMetadata>,
    pub variadic: Option<DialectFunctionVariadic>,
}

DialectFunction

JSON schema

{
 "type": "object",
 "required": [
   "name",
   "source",
   "supported_impls"
 ],
 "properties": {
   "metadata": {
     "description": "Arbitrary data created by the dialect author.",
     "type": "object"
   },
   "name": {
     "description": "The name of the function as declared in the extension it is defined in.\n",
     "type": "string"
   },
   "required_options": {
     "description": "Function-specific options that must be supported by the dialect.  These are the exact list of options that must be used.  If no options are listed here, no options must be present.\n",
     "type": "object"
   },
   "source": {
     "description": "Dependency (alias) in which the function is declared.",
     "type": "string"
   },
   "supported_impls": {
     "description": "List of one or more implementations supported by this function. Use argument signatures to identify the implementations. An implementation that takes no arguments has an empty argument signature and is identified by the empty string. For example, [\"i64\", \"\"] identifies two implementations: one taking a single i64 argument, and one taking no arguments.\n",
     "type": "array",
     "items": {
       "type": "string"
     },
     "minItems": 1
   },
   "system_metadata": {
     "description": "system specific metadata for the function",
     "type": "object",
     "$ref": "#/definitions/system_function_metadata"
   },
   "variadic": {
     "description": "If present, indicates the function accepts a variable number of arguments. Specifies the minimum and/or maximum number of arguments allowed.\n",
     "type": "object",
     "properties": {
       "max": {
         "description": "Maximum number of arguments allowed",
         "type": "integer",
         "minimum": 1.0
       },
       "min": {
         "description": "Minimum number of arguments required",
         "type": "integer",
         "minimum": 1.0
       }
     },
     "additionalProperties": false
   }
 },
 "additionalProperties": false
}

Fields

metadata: Map<String, Value>

Arbitrary data created by the dialect author.

name: String

The name of the function as declared in the extension it is defined in.

required_options: Map<String, Value>

Function-specific options that must be supported by the dialect. These are the exact list of options that must be used. If no options are listed here, no options must be present.

source: String

Dependency (alias) in which the function is declared.

supported_impls: Vec<String>

List of one or more implementations supported by this function. Use argument signatures to identify the implementations. An implementation that takes no arguments has an empty argument signature and is identified by the empty string. For example, [“i64”, “”] identifies two implementations: one taking a single i64 argument, and one taking no arguments.

system_metadata: Option<SystemFunctionMetadata>

system specific metadata for the function

variadic: Option<DialectFunctionVariadic>

Implementations

impl DialectFunction

pub fn builder() -> DialectFunction

Trait Implementations

impl Clone for DialectFunction

fn clone(&self) -> DialectFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DialectFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DialectFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DialectFunction> for DialectFunction

fn from(value: DialectFunction) -> Self

Converts to this type from the input type.

impl PartialEq for DialectFunction

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DialectFunction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DialectFunction

impl TryFrom<DialectFunction> for DialectFunction

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: DialectFunction) -> Result<Self, ConversionError>

Performs the conversion.