Struct polars_sql::function_registry::FunctionOptions

pub struct FunctionOptions {
    pub collect_groups: ApplyOptions,
    pub fmt_str: &'static str,
    pub cast_to_supertypes: Option<SuperTypeOptions>,
    pub check_lengths: UnsafeBool,
    pub flags: FunctionFlags,
}

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

cast_to_supertypes: Option<SuperTypeOptions>

check_lengths: UnsafeBool

flags: FunctionFlags

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

pub fn is_elementwise(&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

Tests for self and other values to be equal, and is used by ==.

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

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