Enum Type

pub enum Type {
    PrimitiveType {
        basic_info: BasicTypeInfo,
        physical_type: Type,
        type_length: i32,
        scale: i32,
        precision: i32,
    },
    GroupType {
        basic_info: BasicTypeInfo,
        fields: Vec<TypePtr>,
    },
}

Representation of a Parquet type.

Used to describe primitive leaf fields and structs, including top-level schema.

Note that the top-level schema is represented using Type::GroupType whose repetition is None.

Variants

PrimitiveType

Represents a primitive leaf field.

Fields

basic_info: BasicTypeInfo

Basic information about the type.

physical_type: Type

Physical type of this primitive type.

type_length: i32

Length of this type.

scale: i32

Scale of this type.

precision: i32

Precision of this type.

GroupType

Represents a group of fields (similar to struct).

Fields

basic_info: BasicTypeInfo

Basic information about the type.

fields: Vec<TypePtr>

Fields of this group type.

Implementations

impl Type

pub fn primitive_type_builder( name: &str, physical_type: PhysicalType, ) -> PrimitiveTypeBuilder<'_>

Creates primitive type builder with provided field name and physical type.

pub fn group_type_builder(name: &str) -> GroupTypeBuilder<'_>

Creates group type builder with provided column name.

pub fn get_basic_info(&self) -> &BasicTypeInfo

Returns BasicTypeInfo information about the type.

pub fn name(&self) -> &str

Returns this type’s field name.

pub fn get_fields(&self) -> &[TypePtr]

Gets the fields from this group type. Note that this will panic if called on a non-group type.

pub fn get_physical_type(&self) -> PhysicalType

Gets physical type of this primitive type. Note that this will panic if called on a non-primitive type.

pub fn get_precision(&self) -> i32

Gets precision of this primitive type. Note that this will panic if called on a non-primitive type.

pub fn get_scale(&self) -> i32

Gets scale of this primitive type. Note that this will panic if called on a non-primitive type.

pub fn check_contains(&self, sub_type: &Type) -> bool

Checks if sub_type schema is part of current schema. This method can be used to check if projected columns are part of the root schema.

pub fn is_primitive(&self) -> bool

Returns true if this type is a primitive type, false otherwise.

pub fn is_group(&self) -> bool

Returns true if this type is a group type, false otherwise.

pub fn is_schema(&self) -> bool

Returns true if this type is the top-level schema type (message type).

pub fn is_optional(&self) -> bool

Returns true if this type is repeated or optional. If this type doesn’t have repetition defined, we treat it as required.

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

Returns true if this type is annotated as a list.

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

Returns true if this type is a group with a single child field that is repeated.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl HeapSize for Type

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 PartialEq for Type

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