Struct FileScanTask 

pub struct FileScanTask { /* private fields */ }

A task to scan part of file.

Implementations

impl FileScanTask

pub fn builder() -> FileScanTaskBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building FileScanTask. On the builder, call .file_size_in_bytes(...), .start(...), .length(...), .record_count(...)(optional), .first_row_id(...)(optional), .data_sequence_number(...)(optional), .data_file_path(...), .data_file_format(...), .schema(...), .project_field_ids(...), .predicate(...)(optional), .deletes(...)(optional), .partition(...)(optional), .partition_spec(...)(optional), .name_mapping(...)(optional), .unified_partition_type(...)(optional), .case_sensitive(...), .key_metadata(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FileScanTask.

impl FileScanTask

pub fn file_size_in_bytes(&self) -> u64

Returns the total size of the data file in bytes.

pub fn start(&self) -> u64

Returns the start offset of the file to scan.

pub fn length(&self) -> u64

Returns the length of the file to scan.

pub fn record_count(&self) -> Option<u64>

Returns the number of records in the file when the whole file is scanned.

pub fn first_row_id(&self) -> Option<i64>

Returns the first row id assigned to the data file.

pub fn data_sequence_number(&self) -> Option<i64>

Returns the data sequence number of the file.

pub fn data_file_path(&self) -> &str

Returns the data file path of this file scan task.

pub fn data_file_format(&self) -> DataFileFormat

Returns the format of the data file.

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.

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 deletes(&self) -> &[FileScanTaskDeleteFile]

Returns the delete files that may need to be applied to the data file.

pub fn partition(&self) -> Option<&Struct>

Returns the partition data from the manifest entry.

pub fn partition_spec(&self) -> Option<&Arc<PartitionSpec>>

Returns the partition spec for the data file.

pub fn name_mapping(&self) -> Option<&Arc<NameMapping>>

Returns the name mapping used to resolve field ids.

pub fn unified_partition_type(&self) -> Option<&Arc<StructType>>

Returns the unified partition type across all table partition specs.

pub fn case_sensitive(&self) -> bool

Returns whether names are treated as case-sensitive.

pub fn key_metadata(&self) -> Option<&[u8]>

Returns the key metadata for the encrypted data file.

Trait Implementations

impl Clone for FileScanTask

fn clone(&self) -> FileScanTask

Returns a duplicate 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 From<FileScanTask> for Result<FileScanTask>

fn from(task: FileScanTask) -> Self

Converts to this type from the input type.

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