Struct polars_sql::function_registry::FunctionOptions

pub struct FunctionOptions {
    pub collect_groups: ApplyOptions,
    pub fmt_str: &'static str,
    pub input_wildcard_expansion: bool,
    pub returns_scalar: bool,
    pub cast_to_supertypes: bool,
    pub allow_rename: bool,
    pub pass_name_to_apply: bool,
    pub changes_length: bool,
    pub check_lengths: UnsafeBool,
    pub allow_group_aware: bool,
}

Fields

collect_groups: ApplyOptions

Collect groups to a list and apply the function over the groups. This can be important in aggregation context.

fmt_str: &'static str

input_wildcard_expansion: bool

There can be two ways of expanding wildcards:

Say the schema is ‘a’, ‘b’ and there is a function f. In this case, f('*') can expand to:

1. f('a', 'b')
2. f('a'), f('b')

Setting this to true, will lead to behavior 1.

This also accounts for regex expansion.

returns_scalar: bool

Automatically explode on unit length if 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}

cast_to_supertypes: bool

allow_rename: bool

pass_name_to_apply: bool

changes_length: bool

check_lengths: UnsafeBool

allow_group_aware: bool

Implementations

impl FunctionOptions

pub fn is_groups_sensitive(&self) -> bool

Any function that is sensitive to the number of elements in a group

• Aggregations
• Sorts
• Counts

pub fn check_lengths(&self) -> 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<(), Error>

Formats the value using the given formatter.

impl Default for FunctionOptions

fn default() -> FunctionOptions

Returns the “default value” for a type.

impl Hash for FunctionOptions

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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 Copy for FunctionOptions

impl Eq for FunctionOptions

impl StructuralPartialEq for FunctionOptions