Struct Function

pub struct Function {
    pub name: String,
    pub args: Vec<BExpression>,
    pub aggregation: Option<Aggregation>,
    pub subquery: Option<Subquery>,
    pub span: Option<Span>,
}

A function call.

Note that function names, arguments, argument types, and return types are not validated.

Fields

name: String

args: Vec<BExpression>

aggregation: Option<Aggregation>

subquery: Option<Subquery>

span: Option<Span>

Implementations

impl Function

pub fn new<S: Into<String>>(name: S) -> Function

pub fn name<S: Into<String>>(self, name: S) -> Self

Replaces this Function’s name with the given string

Note that the new name is not validated.

pub fn arg(self, arg: Expression) -> Self

Adds the given expression as new argument to this function

pub fn aggregation(self, aggregation: Aggregation) -> Self

Sets this Function’s aggregation clause

pub fn clear_aggregation(self) -> Self

Clears this Function’s aggregation clause, if any

pub fn subquery(self, subquery: Subquery) -> Self

pub fn clear_subquery(self) -> Self

pub fn span<S: Into<Span>>(self, span: S) -> Self

pub fn wrap(self) -> Expression

Wraps this function in an Expression

pub fn return_value(&self) -> ReturnValue

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Function