datafusion_expr::function

Struct WindowUDFFieldArgs

Source 
pub struct WindowUDFFieldArgs<'a> { /* private fields */ }
Expand description

Metadata for defining the result field from evaluating a user-defined window function.

Implementations§

Source§

impl<'a> WindowUDFFieldArgs<'a>

Source

pub fn new( input_fields: &'a [Arc<Field>], display_name: &'a str, ) -> WindowUDFFieldArgs<'a>

Create an instance of WindowUDFFieldArgs.

§Arguments
  • input_fields - The fields corresponding to the arguments to the user-defined window function.
  • function_name - The qualified schema name of the user-defined window function expression.
Source

pub fn input_fields(&self) -> &[Arc<Field>]

Returns the field of input expressions passed as arguments to the user-defined window function.

Source

pub fn name(&self) -> &str

Returns the name for the field of the final result of evaluating the user-defined window function.

Source

pub fn get_input_field(&self, index: usize) -> Option<Arc<Field>>

Returns Some(Field) of input expression at index, otherwise returns None if the index is out of bounds.

Auto Trait Implementations§

§

impl<'a> Freeze for WindowUDFFieldArgs<'a>

§

impl<'a> RefUnwindSafe for WindowUDFFieldArgs<'a>

§

impl<'a> Send for WindowUDFFieldArgs<'a>

§

impl<'a> Sync for WindowUDFFieldArgs<'a>

§

impl<'a> Unpin for WindowUDFFieldArgs<'a>

§

impl<'a> UnwindSafe for WindowUDFFieldArgs<'a>

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,