Struct SystemFunctionMetadata 

pub struct SystemFunctionMetadata {
    pub name: Option<String>,
    pub notation: SystemFunctionMetadataNotation,
}

System specific metadata for use in mapping Substrait to and from Common metadata fields are defined for use across dialects. Individual dialects may include additional metadata to serve their purposes.

JSON schema

{
 "description": "System specific metadata for use in mapping Substrait to and from Common metadata fields are defined for use across dialects. Individual dialects may include additional metadata to serve their purposes.\n",
 "type": "object",
 "properties": {
   "name": {
     "description": "The name for this function in the system modelled by the dialect. For example, \"+\" might be the system name for \"add\".\n",
     "type": "string"
   },
   "notation": {
     "description": "The notation used to invoke this function in the system modelled by the dialect. For example, a function with system_name \"+\" could be invoked as follow: * INFIX:    \"a + b\" * POSTFIX:  \"a b +\", * PREFIX:   \"+ a b\" * FUNCTION: \"func(a, b)\"\n",
     "default": "FUNCTION",
     "type": "string",
     "enum": [
       "INFIX",
       "POSTFIX",
       "PREFIX",
       "FUNCTION"
     ]
   }
 },
 "additionalProperties": false
}

Fields

name: Option<String>

The name for this function in the system modelled by the dialect. For example, “+” might be the system name for “add”.

notation: SystemFunctionMetadataNotation

The notation used to invoke this function in the system modelled by the dialect. For example, a function with system_name “+” could be invoked as follow: * INFIX: “a + b” * POSTFIX: “a b +”, * PREFIX: “+ a b” * FUNCTION: “func(a, b)”

Implementations

impl SystemFunctionMetadata

pub fn builder() -> SystemFunctionMetadata

Trait Implementations

impl Clone for SystemFunctionMetadata

fn clone(&self) -> SystemFunctionMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemFunctionMetadata

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

Formats the value using the given formatter.

impl Default for SystemFunctionMetadata

fn default() -> SystemFunctionMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SystemFunctionMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SystemFunctionMetadata> for SystemFunctionMetadata

fn from(value: SystemFunctionMetadata) -> SystemFunctionMetadata

Converts to this type from the input type.

impl PartialEq for SystemFunctionMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SystemFunctionMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SystemFunctionMetadata

impl TryFrom<SystemFunctionMetadata> for SystemFunctionMetadata

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.