Enum FunctionIR

pub enum FunctionIR {
    OpaquePython(OpaquePythonUdf),
    Opaque {
        function: Arc<dyn DataFrameUdf>,
        schema: Option<Arc<dyn UdfSchema>>,
        predicate_pd: bool,
        projection_pd: bool,
        streamable: bool,
        fmt_str: PlSmallStr,
    },
    FastCount {
        sources: ScanSources,
        scan_type: FileScan,
        alias: Option<PlSmallStr>,
    },
    Pipeline {
        function: Arc<Mutex<dyn DataFrameUdfMut>>,
        schema: SchemaRef,
        original: Option<Arc<IRPlan>>,
    },
    Unnest {
        columns: Arc<[PlSmallStr]>,
    },
    Rechunk,
    MergeSorted {
        column: PlSmallStr,
    },
    Rename {
        existing: Arc<[PlSmallStr]>,
        new: Arc<[PlSmallStr]>,
        swapping: bool,
        schema: CachedSchema,
    },
    Explode {
        columns: Arc<[PlSmallStr]>,
        schema: CachedSchema,
    },
    Unpivot {
        args: Arc<UnpivotArgsIR>,
        schema: CachedSchema,
    },
    RowIndex {
        name: PlSmallStr,
        schema: CachedSchema,
        offset: Option<IdxSize>,
    },
}

Variants

OpaquePython(OpaquePythonUdf)

Available on crate feature python only.

Opaque

Fields

function: Arc<dyn DataFrameUdf>

schema: Option<Arc<dyn UdfSchema>>

predicate_pd: bool

allow predicate pushdown optimizations

projection_pd: bool

allow projection pushdown optimizations

streamable: bool

fmt_str: PlSmallStr

FastCount

Fields

sources: ScanSources

scan_type: FileScan

alias: Option<PlSmallStr>

Pipeline

Streaming engine pipeline

Fields

function: Arc<Mutex<dyn DataFrameUdfMut>>

schema: SchemaRef

original: Option<Arc<IRPlan>>

Unnest

Fields

columns: Arc<[PlSmallStr]>

Rechunk

MergeSorted

Available on crate feature merge_sorted only.

Fields

column: PlSmallStr

Rename

Fields

existing: Arc<[PlSmallStr]>

new: Arc<[PlSmallStr]>

swapping: bool

schema: CachedSchema

Explode

Fields

columns: Arc<[PlSmallStr]>

schema: CachedSchema

Unpivot

Available on crate feature pivot only.

Fields

args: Arc<UnpivotArgsIR>

schema: CachedSchema

RowIndex

Fields

name: PlSmallStr

schema: CachedSchema

offset: Option<IdxSize>

Implementations

impl FunctionIR

pub fn is_streamable(&self) -> bool

Whether this function can run on batches of data at a time.

pub fn expands_rows(&self) -> bool

Whether this function will increase the number of rows

pub fn evaluate(&self, df: DataFrame) -> PolarsResult<DataFrame>

pub fn to_streaming_lp(&self) -> Option<IRPlanRef<'_>>

Trait Implementations

impl Clone for FunctionIR

fn clone(&self) -> FunctionIR

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionIR

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

Formats the value using the given formatter.

impl Display for FunctionIR

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum FunctionIR> for &'static str

fn from(x: &'_derivative_strum FunctionIR) -> &'static str

Converts to this type from the input type.

impl From<FunctionIR> for &'static str

fn from(x: FunctionIR) -> &'static str

Converts to this type from the input type.

impl From<FunctionIR> for DslFunction

fn from(value: FunctionIR) -> Self

Converts to this type from the input type.

impl Hash for FunctionIR

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

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 FunctionIR

fn eq(&self, other: &Self) -> 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 Eq for FunctionIR