Struct polars_lazy::dsl::udf::UserDefinedFunction

pub struct UserDefinedFunction {
    pub name: String,
    pub input_fields: Vec<Field>,
    pub return_type: SpecialEq<Arc<dyn FunctionOutputField>>,
    pub fun: SpecialEq<Arc<dyn SeriesUdf>>,
    pub options: FunctionOptions,
}
Expand description

Represents a user-defined function

Fields§

§name: String

name

§input_fields: Vec<Field>

The function signature.

§return_type: SpecialEq<Arc<dyn FunctionOutputField>>

The function output type.

§fun: SpecialEq<Arc<dyn SeriesUdf>>

The function implementation.

§options: FunctionOptions

Options for the function.

Implementations§

§

impl UserDefinedFunction

pub fn new( name: &str, input_fields: Vec<Field>, return_type: SpecialEq<Arc<dyn FunctionOutputField>>, fun: impl SeriesUdf + 'static ) -> UserDefinedFunction

Create a new UserDefinedFunction

pub fn call(self, args: Vec<Expr>) -> Result<Expr, PolarsError>

creates a logical expression with a call of the UDF This utility allows using the UDF without requiring access to the registry. The schema is validated and the query will fail if the schema is invalid.

pub fn call_unchecked(self, args: Vec<Expr>) -> Expr

creates a logical expression with a call of the UDF This does not do any schema validation and is therefore faster.

Only use this if you are certain that the schema is correct. If the schema is invalid, the query will fail at runtime.

Trait Implementations§

§

impl Clone for UserDefinedFunction

§

fn clone(&self) -> UserDefinedFunction

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for UserDefinedFunction

§

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

Formats the value using the given formatter. Read more

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> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

§

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>,

§

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>,

§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> Ungil for T
where T: Send,