Struct polars_plan::prelude::FunctionOptions

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:

1. f(‘a’, ‘b’) or
2. 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

impl Clone for FunctionOptions

fn clone(&self) -> FunctionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionOptions

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

Formats the value using the given formatter.

impl Default for FunctionOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<FunctionOptions> for FunctionOptions

fn eq(&self, other: &FunctionOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FunctionOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FunctionOptions

impl Eq for FunctionOptions

impl StructuralEq for FunctionOptions

impl StructuralPartialEq for FunctionOptions