datafusion_ffi::udwf

Struct ForeignWindowUDF

pub struct ForeignWindowUDF { /* private fields */ }

Expand description

This struct is used to access an UDF provided by a foreign library across a FFI boundary.

The ForeignWindowUDF is to be used by the caller of the UDF, so it has no knowledge or access to the private data. All interaction with the UDF must occur through the functions defined in FFI_WindowUDF.

Trait Implementations§

impl Debug for ForeignWindowUDF

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

Formats the value using the given formatter. Read more

impl TryFrom<&FFI_WindowUDF> for ForeignWindowUDF

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from(udf: &FFI_WindowUDF) -> Result<Self, Self::Error>

Performs the conversion.

impl WindowUDFImpl for ForeignWindowUDF

fn as_any(&self) -> &dyn Any

Returns this object as an Any trait object

fn name(&self) -> &str

Returns this function’s name

fn signature(&self) -> &Signature

Returns the function’s Signature for information about what input types are accepted and the function’s Volatility.

fn aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function. Read more

fn coerce_types(&self, arg_types: &[DataType]) -> Result<Vec<DataType>>

Coerce arguments of a function call to types that the function can evaluate. Read more

fn partition_evaluator( &self, args: PartitionEvaluatorArgs<'_>, ) -> Result<Box<dyn PartitionEvaluator>>

Invoke the function, returning the PartitionEvaluator instance

fn field(&self, field_args: WindowUDFFieldArgs<'_>) -> Result<FieldRef>

The FieldRef of the final result of evaluating this window function. Read more

fn sort_options(&self) -> Option<SortOptions>

Allows the window UDF to define a custom result ordering. Read more

fn expressions( &self, expr_args: ExpressionArgs<'_>, ) -> Vec<Arc<dyn PhysicalExpr>>

Returns the expressions that are passed to the PartitionEvaluator.

fn simplify( &self, ) -> Option<Box<dyn Fn(WindowFunction, &dyn SimplifyInfo) -> Result<Expr, DataFusionError>>>

Optionally apply per-UDWF simplification / rewrite rules. Read more

fn equals(&self, other: &dyn WindowUDFImpl) -> bool

Return true if this window UDF is equal to the other. Read more

fn hash_value(&self) -> u64

Returns a hash value for this window UDF. Read more

fn reverse_expr(&self) -> ReversedUDWF

Allows customizing the behavior of the user-defined window function when it is evaluated in reverse order.

fn documentation(&self) -> Option<&Documentation>

Returns the documentation for this Window UDF. Read more

impl Send for ForeignWindowUDF

impl Sync for ForeignWindowUDF

Auto Trait Implementations§

impl Freeze for ForeignWindowUDF

impl !RefUnwindSafe for ForeignWindowUDF

impl Unpin for ForeignWindowUDF

impl !UnwindSafe for ForeignWindowUDF

Blanket Implementations§

impl<T> AlignerFor<1> for T

type Aligner = AlignTo1<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<1024> for T

type Aligner = AlignTo1024<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<128> for T

type Aligner = AlignTo128<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16> for T

type Aligner = AlignTo16<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16384> for T

type Aligner = AlignTo16384<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2> for T

type Aligner = AlignTo2<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2048> for T

type Aligner = AlignTo2048<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<256> for T

type Aligner = AlignTo256<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32> for T

type Aligner = AlignTo32<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32768> for T

type Aligner = AlignTo32768<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4> for T

type Aligner = AlignTo4<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4096> for T

type Aligner = AlignTo4096<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<512> for T

type Aligner = AlignTo512<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<64> for T

type Aligner = AlignTo64<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8> for T

type Aligner = AlignTo8<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8192> for T

type Aligner = AlignTo8192<T>

The AlignTo* type which aligns Self to ALIGNMENT.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<S> ROExtAcc for S

fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

Gets a reference to a field, determined by offset. Read more

fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

Gets a muatble reference to a field, determined by offset. Read more

fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

Gets a const pointer to a field, the field is determined by offset. Read more

fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F

Gets a mutable pointer to a field, determined by offset. Read more

impl<S> ROExtOps<Aligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Aligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<S> ROExtOps<Unaligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

fn eq_id(&self, other: &Self) -> bool

Compares the address of self with the address of other. Read more

fn piped<F, U>(self, f: F) -> U
where F: FnOnce(Self) -> U, Self: Sized,

Emulates the pipeline operator, allowing method syntax in more places. Read more

fn piped_ref<'a, F, U>(&'a self, f: F) -> U
where F: FnOnce(&'a Self) -> U,

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> U
where F: FnOnce(&'a mut Self) -> U,

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self.

fn mutated<F>(self, f: F) -> Self
where F: FnOnce(&mut Self), Self: Sized,

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

fn observe<F>(self, f: F) -> Self
where F: FnOnce(&Self), Self: Sized,

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

fn into_<T>(self) -> T
where Self: Into<T>,

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

fn as_ref_<T>(&self) -> &T
where Self: AsRef<T>, T: ?Sized,

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

fn as_mut_<T>(&mut self) -> &mut T
where Self: AsMut<T>, T: ?Sized,

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

fn drop_(self)
where Self: Sized,

Drops self using method notation. Alternative to std::mem::drop. Read more

impl<This> TransmuteElement for This
where This: ?Sized,

unsafe fn transmute_element<T>(self) -> Self::TransmutedPtr
where Self: CanTransmuteElement<T>,

Transmutes the element type of this pointer.. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Type = T

This is always Self.

fn into_type(self) -> Self::Type
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn as_type(&self) -> &Self::Type

Converts a reference back to the original type.

fn as_type_mut(&mut self) -> &mut Self::Type

Converts a mutable reference back to the original type.

fn into_type_box(self: Box<Self>) -> Box<Self::Type>

Converts a box back to the original type.

fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>

Converts an Arc back to the original type. Read more

fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>

Converts an Rc back to the original type. Read more

fn from_type(this: Self::Type) -> Self
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn from_type_ref(this: &Self::Type) -> &Self

Converts a reference back to the original type.

fn from_type_mut(this: &mut Self::Type) -> &mut Self

Converts a mutable reference back to the original type.

fn from_type_box(this: Box<Self::Type>) -> Box<Self>

Converts a box back to the original type.

fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>

Converts an Arc back to the original type.

fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>

Converts an Rc back to the original type.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> ErasedDestructor for T
where T: 'static,