Struct ValueStatistics

pub struct ValueStatistics<T> {
    min: Option<T>,
    max: Option<T>,
    distinct_count: Option<u64>,
    null_count: Option<u64>,
    is_max_value_exact: bool,
    is_min_value_exact: bool,
    is_min_max_deprecated: bool,
    is_min_max_backwards_compatible: bool,
}

Typed statistics for one column chunk

See Statistics for more details

Fields

min: Option<T>

max: Option<T>

distinct_count: Option<u64>

null_count: Option<u64>

is_max_value_exact: bool

is_min_value_exact: bool

is_min_max_deprecated: bool

If true populate the deprecated min and max fields instead of min_value and max_value

is_min_max_backwards_compatible: bool

If true the statistics are compatible with the deprecated min and max fields. See ValueStatistics::is_min_max_backwards_compatible

Implementations

impl<T: ParquetValueType> ValueStatistics<T>

pub fn new( min: Option<T>, max: Option<T>, distinct_count: Option<u64>, null_count: Option<u64>, is_min_max_deprecated: bool, ) -> Self

Creates new typed statistics.

pub fn with_min_is_exact(self, is_min_value_exact: bool) -> Self

Set whether the stored min field represents the exact minimum, or just a bound on the minimum value.

see Self::min_is_exact

pub fn with_max_is_exact(self, is_max_value_exact: bool) -> Self

Set whether the stored max field represents the exact maximum, or just a bound on the maximum value.

see Self::max_is_exact

pub fn with_backwards_compatible_min_max( self, backwards_compatible: bool, ) -> Self

Set whether to write the deprecated min and max fields for compatibility with older parquet writers

This should only be enabled if the field is signed, see Self::is_min_max_backwards_compatible

pub fn min(&self) -> &T

👎Deprecated since 53.0.0: Use min_opt instead

Returns min value of the statistics.

Panics if min value is not set, e.g. all values are null. Use has_min_max_set method to check that.

pub fn min_opt(&self) -> Option<&T>

Returns min value of the statistics, if known.

pub fn max(&self) -> &T

👎Deprecated since 53.0.0: Use max_opt instead

Returns max value of the statistics.

Panics if max value is not set, e.g. all values are null. Use has_min_max_set method to check that.

pub fn max_opt(&self) -> Option<&T>

Returns max value of the statistics, if known.

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

Returns min value as bytes of the statistics, if min value is known.

pub fn min_bytes(&self) -> &[u8]

👎Deprecated since 53.0.0: Use min_bytes_opt instead

Returns min value as bytes of the statistics.

Panics if min value is not set, use has_min_max_set method to check if values are set.

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

Returns max value as bytes of the statistics, if max value is known.

pub fn max_bytes(&self) -> &[u8]

👎Deprecated since 53.0.0: Use max_bytes_opt instead

Returns max value as bytes of the statistics.

Panics if max value is not set, use has_min_max_set method to check if values are set.

pub fn has_min_max_set(&self) -> bool

👎Deprecated since 53.0.0: Use min_opt and max_opt methods instead

Whether or not min and max values are set. Normally both min/max values will be set to Some(value) or None.

pub(crate) fn _internal_has_min_max_set(&self) -> bool

Whether or not min and max values are set. Normally both min/max values will be set to Some(value) or None.

pub fn max_is_exact(&self) -> bool

Whether or not max value is set, and is an exact value.

pub fn min_is_exact(&self) -> bool

Whether or not min value is set, and is an exact value.

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

Returns optional value of number of distinct values occurring.

pub fn null_count(&self) -> u64

👎Deprecated since 53.0.0: Use null_count_opt method instead

Returns number of null values for the column. Note that this includes all nulls when column is part of the complex type.

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

Returns null count.

fn is_min_max_deprecated(&self) -> bool

Returns true if statistics were created using old min/max fields.

pub fn is_min_max_backwards_compatible(&self) -> bool

Old versions of parquet stored statistics in min and max fields, ordered using signed comparison. This resulted in an undefined ordering for unsigned quantities, such as booleans and unsigned integers.

These fields were therefore deprecated in favour of min_value and max_value, which have a type-defined sort order.

However, not all readers have been updated. For backwards compatibility, this method returns true if the statistics within this have a signed sort order, that is compatible with being stored in the deprecated min and max fields

Trait Implementations

impl<T: Clone> Clone for ValueStatistics<T>

fn clone(&self) -> ValueStatistics<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ParquetValueType> Debug for ValueStatistics<T>

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

Formats the value using the given formatter.

impl<T: ParquetValueType> Display for ValueStatistics<T>

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

Formats the value using the given formatter.

impl<T: ParquetValueType> From<ValueStatistics<T>> for Statistics

fn from(t: ValueStatistics<T>) -> Self

Converts to this type from the input type.

impl<T: ParquetValueType> HeapSize for ValueStatistics<T>

fn heap_size(&self) -> usize

Return the size of any bytes allocated on the heap by this object, including heap memory in those structures

impl<T: PartialEq> PartialEq for ValueStatistics<T>

fn eq(&self, other: &ValueStatistics<T>) -> 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<T: Eq> Eq for ValueStatistics<T>

impl<T> StructuralPartialEq for ValueStatistics<T>