Struct FileStatistics 

pub struct FileStatistics { /* private fields */ }

Contains statistical information about the data in a Vortex file.

This struct wraps an array of StatsSet objects, each containing statistics for a field or column in the file. These statistics can be used for query optimization and data exploration.

Implementations

impl FileStatistics

pub fn new(stats: Arc<[StatsSet]>, dtypes: Arc<[DType]>) -> Self

Creates a new FileStatistics from the given statistics and data types.

Panics

Panics if stats and dtypes have different lengths.

pub fn new_with_dtype(stats: Arc<[StatsSet]>, file_dtype: &DType) -> Self

Creates a new FileStatistics from the given statistics and file dtype.

If the DType of the file is a DType::Struct, then there must be the same number of stats as struct fields. Otherwise, there must be only 1 statistic.

Panics

Panics if the number of stats doesn’t match the expected number based on the dtype.

pub fn from_flatbuffer<'a>( fb: &FileStatistics<'a>, file_dtype: &DType, ) -> VortexResult<Self>

Creates FileStatistics from a flatbuffers fb::FileStatistics<'a>.

If the DType of the file is a DType::Struct, then there must be the same number of file stats in the flatbuffer. Otherwise, there must be only 1 statistic.

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

Returns a reference to the statistics sets.

pub fn dtypes(&self) -> &Arc<[DType]>

Returns a reference to the data types.

pub fn get(&self, field_idx: usize) -> (&StatsSet, &DType)

Returns the statistics and data type for a specific field.

Panics

Panics if field_idx is out of bounds.

Trait Implementations

impl Clone for FileStatistics

fn clone(&self) -> FileStatistics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileStatistics

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

Formats the value using the given formatter.

impl WriteFlatBuffer for FileStatistics

type Target<'a> = FileStatistics<'a>

The FlatBuffer type that this type can be written to.

fn write_flatbuffer<'fb>( &self, fbb: &mut FlatBufferBuilder<'fb>, ) -> VortexResult<WIPOffset<Self::Target<'fb>>>

Writes this type to a FlatBuffer builder.

impl FlatBufferRoot for FileStatistics