Struct VortexFile

pub struct VortexFile { /* private fields */ }

Represents a Vortex file, providing access to its metadata and content.

A VortexFile is created by opening a Vortex file using VortexOpenOptions. It provides methods for accessing file metadata (such as row count, data type, and statistics) and for initiating scans to read the file’s contents.

Implementations

impl VortexFile

pub fn footer(&self) -> &Footer

Returns a reference to the file’s footer, which contains metadata and layout information.

pub fn row_count(&self) -> u64

Returns the number of rows in the file.

pub fn dtype(&self) -> &DType

Returns the data type of the file’s contents.

pub fn file_stats(&self) -> Option<&Arc<[StatsSet]>>

Returns the file’s statistics, if available.

Statistics can be used for query optimization and data exploration.

pub fn metrics(&self) -> &VortexMetrics

Returns a reference to the file’s metrics.

pub fn segment_source(&self) -> Arc<dyn SegmentSource>

Create a new segment source for reading from the file.

This may spawn a background I/O driver that will exit when the returned segment source is dropped.

pub fn layout_reader(&self) -> VortexResult<Arc<dyn LayoutReader>>

Create a new layout reader for the file.

pub fn scan(&self) -> VortexResult<ScanBuilder>

Initiate a scan of the file, returning a builder for configuring the scan.

Trait Implementations

impl Clone for VortexFile

fn clone(&self) -> VortexFile

Returns a copy of the value.

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

Performs copy-assignment from source.