Struct Metadata

pub struct Metadata<T: PolarsDataType> { /* private fields */ }

Implementations

impl<T: PolarsDataType> Metadata<T>

pub const DEFAULT: Metadata<T> = _

pub fn sorted(self, is_sorted: IsSorted) -> Self

pub fn fast_explode_list(self, fast_explode_list: bool) -> Self

pub fn flags(self, flags: MetadataFlags) -> Self

pub fn min_value(self, min_value: T::OwnedPhysical) -> Self

pub fn max_value(self, max_value: T::OwnedPhysical) -> Self

pub fn distinct_count(self, distinct_count: IdxSize) -> Self

pub fn sorted_opt(self, is_sorted: Option<IsSorted>) -> Self

pub fn fast_explode_list_opt(self, fast_explode_list: Option<bool>) -> Self

pub fn flags_opt(self, flags: Option<MetadataFlags>) -> Self

pub fn min_value_opt(self, min_value: Option<T::OwnedPhysical>) -> Self

pub fn max_value_opt(self, max_value: Option<T::OwnedPhysical>) -> Self

pub fn distinct_count_opt(self, distinct_count: Option<IdxSize>) -> Self

pub fn filter_props_cast<O: PolarsDataType>( &self, props: MetadataProperties, ) -> Metadata<O>

Create a Metadata with only the properties set in props.

pub fn filter_props(&self, props: MetadataProperties) -> Self

Create a Metadata with only the properties set in props.

pub fn merge(&self, other: Self) -> MetadataMerge<T>

Merge the maximum information from both Metadatas into one Metadata.

It returns

• MetadataMerge::Keep if the self already contains all the information
• MetadataMerge::New(md) if we have learned new information
• MetadataMerge::Conflict if the two structures contain conflicting metadata

pub fn is_empty(&self) -> bool

pub fn is_sorted_ascending(&self) -> bool

pub fn set_sorted_ascending(&mut self, value: bool)

pub fn is_sorted_descending(&self) -> bool

pub fn set_sorted_descending(&mut self, value: bool)

pub fn get_fast_explode_list(&self) -> bool

pub fn set_fast_explode_list(&mut self, value: bool)

pub fn is_sorted_any(&self) -> bool

pub fn is_sorted(&self) -> IsSorted

pub fn set_sorted_flag(&mut self, is_sorted: IsSorted)

pub fn set_flags(&mut self, flags: MetadataFlags)

pub fn set_min_value(&mut self, min_value: Option<T::OwnedPhysical>)

pub fn set_max_value(&mut self, max_value: Option<T::OwnedPhysical>)

pub fn set_distinct_count(&mut self, distinct_count: Option<IdxSize>)

pub fn get_flags(&self) -> MetadataFlags

pub fn get_min_value(&self) -> Option<&T::OwnedPhysical>

pub fn get_max_value(&self) -> Option<&T::OwnedPhysical>

pub fn get_distinct_count(&self) -> Option<IdxSize>

Trait Implementations

impl<T: PolarsDataType> Clone for Metadata<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PolarsDataType> Debug for Metadata<T>

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

Formats the value using the given formatter.

impl<T: PolarsDataType> Default for Metadata<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PolarsDataType> MetadataTrait for Metadata<T>

where T::OwnedPhysical: IntoScalar + Clone,

fn get_flags(&self) -> MetadataFlags

fn min_value(&self) -> Option<Scalar>

fn max_value(&self) -> Option<Scalar>

fn distinct_count(&self) -> Option<IdxSize>

Number of unique non-null values