Struct Function

pub struct Function {
    pub name: &'static str,
    pub overloads: Vec<Box<dyn Overload>>,
    pub aliases: Vec<&'static str>,
    pub method_aliases: Vec<(Type, &'static str)>,
}

A GeoScript function.

Fields

name: &'static str

Name of this function.

overloads: Vec<Box<dyn Overload>>

Function’s overloads.

aliases: Vec<&'static str>

Aliases of this function

method_aliases: Vec<(Type, &'static str)>

Method aliases of this function

Implementations

impl Function

pub fn new(name: &'static str) -> Self

Create a new function with the given name. The name MUST be ascii and lowercase

pub fn alias(self, name: &'static str) -> Self

Create an alias for this function

pub fn alias_method(self, self_type: Type, name: &'static str) -> Self

Create an alias for this function. For point collections, self_type length of 0 means any point collection. For numbers, unit of None means any unit.

pub fn overload<Marker>(self, f: impl IntoOverload<Marker>) -> Self

Add a new overload to this function.

pub fn get_overload(&self, params: &[AnyExpr]) -> Option<&dyn Overload>

Tries to find an overload for the given param types.

Trait Implementations

impl Addable for Function

fn add_to(self, library: &mut Library)