Struct FileScanTask

pub struct FileScanTask {
    pub start: u64,
    pub length: u64,
    pub record_count: Option<u64>,
    pub data_file_path: String,
    pub data_file_format: DataFileFormat,
    pub schema: SchemaRef,
    pub project_field_ids: Vec<i32>,
    pub predicate: Option<BoundPredicate>,
    pub deletes: Vec<FileScanTaskDeleteFile>,
    pub partition: Option<Struct>,
    pub partition_spec: Option<Arc<PartitionSpec>>,
    pub name_mapping: Option<Arc<NameMapping>>,
}

A task to scan part of file.

Fields

start: u64

The start offset of the file to scan.

length: u64

The length of the file to scan.

record_count: Option<u64>

The number of records in the file to scan.

This is an optional field, and only available if we are reading the entire data file.

data_file_path: String

The data file path corresponding to the task.

data_file_format: DataFileFormat

The format of the file to scan.

schema: SchemaRef

The schema of the file to scan.

project_field_ids: Vec<i32>

The field ids to project.

predicate: Option<BoundPredicate>

The predicate to filter.

deletes: Vec<FileScanTaskDeleteFile>

The list of delete files that may need to be applied to this data file

partition: Option<Struct>

Partition data from the manifest entry, used to identify which columns can use constant values from partition metadata vs. reading from the data file. Per the Iceberg spec, only identity-transformed partition fields should use constants.

partition_spec: Option<Arc<PartitionSpec>>

The partition spec for this file, used to distinguish identity transforms (which use partition metadata constants) from non-identity transforms like bucket/truncate (which must read source columns from the data file).

name_mapping: Option<Arc<NameMapping>>

Name mapping from table metadata (property: schema.name-mapping.default), used to resolve field IDs from column names when Parquet files lack field IDs or have field ID conflicts.

Implementations

impl FileScanTask

pub fn data_file_path(&self) -> &str

Returns the data file path of this file scan task.

pub fn project_field_ids(&self) -> &[i32]

Returns the project field id of this file scan task.

pub fn predicate(&self) -> Option<&BoundPredicate>

Returns the predicate of this file scan task.

pub fn schema(&self) -> &Schema

Returns the schema of this file scan task as a reference

pub fn schema_ref(&self) -> SchemaRef

Returns the schema of this file scan task as a SchemaRef

Trait Implementations

impl Clone for FileScanTask

fn clone(&self) -> FileScanTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileScanTask

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileScanTask

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileScanTask

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileScanTask