Struct UnifiedScanArgs 

pub struct UnifiedScanArgs {

    pub schema: Option<Arc<Schema<DataType>>>,
    pub cloud_options: Option<CloudOptions>,
    pub hive_options: HiveOptions,
    pub rechunk: bool,
    pub cache: bool,
    pub glob: bool,
    pub hidden_file_prefix: Option<Arc<[PlSmallStr]>>,
    pub projection: Option<Arc<[PlSmallStr]>>,
    pub column_mapping: Option<ColumnMapping>,
    pub default_values: Option<DefaultFieldValues>,
    pub row_index: Option<RowIndex>,
    pub pre_slice: Option<Slice>,
    pub cast_columns_policy: CastColumnsPolicy,
    pub missing_columns_policy: MissingColumnsPolicy,
    pub extra_columns_policy: ExtraColumnsPolicy,
    pub include_file_paths: Option<PlSmallStr>,
    pub deletion_files: Option<DeletionFilesList>,
    pub table_statistics: Option<TableStatistics>,
    pub row_count: Option<(u64, u64)>,
}

Scan arguments shared across different scan types.

Fields

schema: Option<Arc<Schema<DataType>>>

User-provided schema of the file. Will be inferred during IR conversion if None.

cloud_options: Option<CloudOptions>

hive_options: HiveOptions

rechunk: bool

cache: bool

glob: bool

hidden_file_prefix: Option<Arc<[PlSmallStr]>>

Files with these prefixes will not be read.

projection: Option<Arc<[PlSmallStr]>>

column_mapping: Option<ColumnMapping>

default_values: Option<DefaultFieldValues>

Default values for missing columns.

row_index: Option<RowIndex>

pre_slice: Option<Slice>

Slice applied before predicates

cast_columns_policy: CastColumnsPolicy

missing_columns_policy: MissingColumnsPolicy

extra_columns_policy: ExtraColumnsPolicy

include_file_paths: Option<PlSmallStr>

deletion_files: Option<DeletionFilesList>

table_statistics: Option<TableStatistics>

row_count: Option<(u64, u64)>

Stores (physical, deleted) row counts of the table if known upfront (e.g. for Iceberg). This allows for row-count queries to succeed without scanning all files.

Note, intentionally store u64 instead of IdxSize to avoid erroring if it’s unused.

Implementations

impl UnifiedScanArgs

pub fn has_row_index_or_slice(&self) -> bool

Trait Implementations

impl Clone for UnifiedScanArgs

fn clone(&self) -> UnifiedScanArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnifiedScanArgs

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

Formats the value using the given formatter.

impl Default for UnifiedScanArgs

fn default() -> UnifiedScanArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnifiedScanArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for UnifiedScanArgs

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 UnifiedScanArgs

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UnifiedScanArgs

impl StructuralPartialEq for UnifiedScanArgs