Struct polars_plan::prelude::FunctionOptions
source · [−]pub struct FunctionOptions {
pub collect_groups: ApplyOptions,
pub input_wildcard_expansion: bool,
pub auto_explode: bool,
pub fmt_str: &'static str,
pub cast_to_supertypes: bool,
pub allow_rename: bool,
}
Fields
collect_groups: ApplyOptions
Collect groups to a list and apply the function over the groups. This can be important in aggregation context.
input_wildcard_expansion: bool
There can be two ways of expanding wildcards:
Say the schema is ‘a’, ‘b’ and there is a function f f(‘*’) can expand to:
- f(‘a’, ‘b’) or
- f(‘a’), f(‘b’)
setting this to true, will lead to behavior 1.
this also accounts for regex expansion
auto_explode: bool
automatically explode on unit length it ran as final aggregation.
this is the case for aggregations like sum, min, covariance etc. We need to know this because we cannot see the difference between the following functions based on the output type and number of elements:
x: {1, 2, 3}
head_1(x) -> {1} sum(x) -> {4}
fmt_str: &'static str
cast_to_supertypes: bool
allow_rename: bool
Trait Implementations
sourceimpl Clone for FunctionOptions
impl Clone for FunctionOptions
sourcefn clone(&self) -> FunctionOptions
fn clone(&self) -> FunctionOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for FunctionOptions
impl Debug for FunctionOptions
sourceimpl Default for FunctionOptions
impl Default for FunctionOptions
sourceimpl<'de> Deserialize<'de> for FunctionOptions
impl<'de> Deserialize<'de> for FunctionOptions
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<FunctionOptions> for FunctionOptions
impl PartialEq<FunctionOptions> for FunctionOptions
sourcefn eq(&self, other: &FunctionOptions) -> bool
fn eq(&self, other: &FunctionOptions) -> bool
sourceimpl Serialize for FunctionOptions
impl Serialize for FunctionOptions
impl Copy for FunctionOptions
impl Eq for FunctionOptions
impl StructuralEq for FunctionOptions
impl StructuralPartialEq for FunctionOptions
Auto Trait Implementations
impl RefUnwindSafe for FunctionOptions
impl Send for FunctionOptions
impl Sync for FunctionOptions
impl Unpin for FunctionOptions
impl UnwindSafe for FunctionOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.