Struct PythonOptions

pub struct PythonOptions {
    pub scan_fn: Option<PythonFunction>,
    pub schema: SchemaRef,
    pub output_schema: Option<SchemaRef>,
    pub with_columns: Option<Arc<[PlSmallStr]>>,
    pub python_source: PythonScanSource,
    pub predicate: PythonPredicate,
    pub n_rows: Option<usize>,
}

Available on crate feature python only.

Fields

scan_fn: Option<PythonFunction>

A function that returns a Python Generator. The generator should produce Polars DataFrame’s.

schema: SchemaRef

Schema of the file.

output_schema: Option<SchemaRef>

Schema the reader will produce when the file is read.

with_columns: Option<Arc<[PlSmallStr]>>

python_source: PythonScanSource

predicate: PythonPredicate

Optional predicate the reader must apply.

n_rows: Option<usize>

A head call passed to the reader.

Trait Implementations

impl Clone for PythonOptions

fn clone(&self) -> PythonOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PythonOptions

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

Formats the value using the given formatter.

impl Default for PythonOptions

fn default() -> PythonOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PythonOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PythonOptions

fn eq(&self, other: &PythonOptions) -> 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 Serialize for PythonOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PythonOptions

impl StructuralPartialEq for PythonOptions