Struct FileScanTaskDeleteFile 

pub struct FileScanTaskDeleteFile {
    pub file_path: String,
    pub file_size_in_bytes: u64,
    pub file_type: DataContentType,
    pub file_format: DataFileFormat,
    pub partition_spec_id: i32,
    pub equality_ids: Option<Vec<i32>>,
    pub referenced_data_file: Option<String>,
    pub content_offset: Option<i64>,
    pub content_size_in_bytes: Option<i64>,
    pub record_count: Option<u64>,
    pub key_metadata: Option<Box<[u8]>>,
}

A task to scan part of file.

Fields

file_path: String

The delete file path

file_size_in_bytes: u64

The total size of the delete file in bytes, from the manifest entry.

file_type: DataContentType

delete file type

file_format: DataFileFormat

The delete file’s format, from the manifest entry. A PositionDeletes entry written as Puffin is a V3 deletion vector; one written as Parquet is a position delete file.

partition_spec_id: i32

partition id

equality_ids: Option<Vec<i32>>

equality ids for equality deletes (null for anything other than equality-deletes)

referenced_data_file: Option<String>

For a deletion vector, the location of the data file whose rows it deletes. Required for deletion vectors, and may also be set on a position delete file scoped to one data file.

content_offset: Option<i64>

For a deletion vector, the offset of the blob within its Puffin file. Set only for deletion vectors, where it locates the blob for direct access.

content_size_in_bytes: Option<i64>

For a deletion vector, the length in bytes of the blob within its Puffin file. Required together with content_offset; both are absent for non-DV delete files.

record_count: Option<u64>

The number of records in the delete file, from the manifest entry; for a deletion vector, the cardinality of its bitmap. None only for a task not built from a manifest entry.

key_metadata: Option<Box<[u8]>>

Key metadata for an encrypted delete file. When present, the reader uses this to decrypt the file: for a Parquet equality or position delete file, this builds FileDecryptionProperties (Parquet Modular Encryption); for a deletion vector, whose Puffin file has no native encryption, this wraps the range read in an EncryptedInputFile (AGS1 stream encryption).

Same plaintext-DEK trust boundary as FileScanTask::key_metadata: this is serialized into the scan plan and crosses the planner -> worker channel in the clear for the standard encryption scheme.

Implementations

impl FileScanTaskDeleteFile

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

Create a builder for building FileScanTaskDeleteFile. On the builder, call .file_path(...), .file_size_in_bytes(...), .file_type(...), .file_format(...), .partition_spec_id(...), .equality_ids(...)(optional), .referenced_data_file(...)(optional), .content_offset(...)(optional), .content_size_in_bytes(...)(optional), .record_count(...)(optional), .key_metadata(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FileScanTaskDeleteFile.

Trait Implementations

impl Clone for FileScanTaskDeleteFile

fn clone(&self) -> FileScanTaskDeleteFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileScanTaskDeleteFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileScanTaskDeleteFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileScanTaskDeleteFile

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

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 FileScanTaskDeleteFile