Skip to main content

FuncExpr

Struct FuncExpr 

Source
pub struct FuncExpr { /* private fields */ }
Expand description

A function call under construction: f("row_number", ()).over(window).

Expr::Func carries the optional OVER window, but OVER is only meaningful on a function call, so the method that sets it lives here rather than on Expr — where it would have to either silently do nothing or panic for the fifteen other variants.

A FuncExpr is an Expression and an IntoExpr, so it can be used wherever an expression is expected without being finished first. Call IntoExpr::into_expr to get the Expr and continue with the operator chain.

The richer function forms — DISTINCT, FILTER (WHERE ..), WITHIN GROUP (..), column definition lists — differ per dialect, and belong to that dialect’s own function builder. It reaches core as Expr::Custom.

Implementations§

Source§

impl FuncExpr

Source

pub fn new( name: impl Into<Cow<'static, str>>, args: impl IntoExprList, ) -> FuncExpr

A function call: name(args..).

Source

pub fn over(self, window: impl IntoExpr) -> Expr

Attach a window: name(args..) OVER (window).

The window may be a definition or the name of one declared in a WINDOW clause; both render inside the same parentheses. An empty expression gives the valid and occasionally useful OVER ().

Ends the builder, because there is nothing further to configure.

Trait Implementations§

Source§

impl Clone for FuncExpr

Source§

fn clone(&self) -> FuncExpr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FuncExpr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Expression for FuncExpr

Source§

fn write_sql(&self, w: &mut SqlWriter<'_>)

Append this fragment to w. Read more
Source§

impl IntoExpr for FuncExpr

Source§

fn into_expr(self) -> Expr

Perform the conversion.
Source§

impl IntoExprList for FuncExpr

Source§

fn into_expr_list(self) -> Vec<Expr>

Perform the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.