Struct ExtensionFunction

pub struct ExtensionFunction { /* private fields */ }

Extension function. These can be called by the given name in Ceder expressions.

Implementations

impl ExtensionFunction

pub fn nullary( name: Name, style: CallStyle, func: Box<dyn Fn() -> Result<ExtensionOutputValue, EvaluationError> + Sync + Send + 'static>, return_type: SchemaType, ) -> Self

Create a new ExtensionFunction taking no arguments

pub fn partial_eval_unknown( name: Name, style: CallStyle, func: Box<dyn Fn(Value) -> Result<ExtensionOutputValue, EvaluationError> + Sync + Send + 'static>, arg_type: SchemaType, ) -> Self

Create a new ExtensionFunction to represent a function which is an “unknown” in partial evaluation. Please don’t use this for anything else.

pub fn unary( name: Name, style: CallStyle, func: Box<dyn Fn(Value) -> Result<ExtensionOutputValue, EvaluationError> + Sync + Send + 'static>, return_type: SchemaType, arg_type: SchemaType, ) -> Self

Create a new ExtensionFunction taking one argument

pub fn binary( name: Name, style: CallStyle, func: Box<dyn Fn(Value, Value) -> Result<ExtensionOutputValue, EvaluationError> + Sync + Send + 'static>, return_type: SchemaType, arg_types: (SchemaType, SchemaType), ) -> Self

Create a new ExtensionFunction taking two arguments

pub fn ternary( name: Name, style: CallStyle, func: Box<dyn Fn(Value, Value, Value) -> Result<ExtensionOutputValue, EvaluationError> + Sync + Send + 'static>, return_type: SchemaType, arg_types: (SchemaType, SchemaType, SchemaType), ) -> Self

Create a new ExtensionFunction taking three arguments

pub fn name(&self) -> &Name

Get the Name of the ExtensionFunction

pub fn style(&self) -> CallStyle

Get the CallStyle of the ExtensionFunction

pub fn return_type(&self) -> Option<&SchemaType>

Get the return type of the ExtensionFunction None is returned exactly when this function represents an “unknown” for partial evaluation.

pub fn arg_types(&self) -> &[SchemaType]

Get the argument types of the ExtensionFunction.

pub fn is_constructor(&self) -> bool

Returns true if this function is considered a “constructor”.

Currently, the only impact of this is that non-constructors are not accessible in the JSON format (entities/json.rs).

pub fn call(&self, args: &[Value]) -> Result<PartialValue, EvaluationError>

Call the ExtensionFunction with the given args

pub fn ext_types(&self) -> impl Iterator<Item = &Name> + '_

Iterate over the extension types that could be produced by this function, if any

Trait Implementations

impl Debug for ExtensionFunction

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

Formats the value using the given formatter.