Struct StructField

pub struct StructField {
    pub name: String,
    pub data_type: DataType,
    pub nullable: bool,
    pub metadata: HashMap<String, MetadataValue>,
}

Fields

name: String

Name of this (possibly nested) column

data_type: DataType

The data type of this field

nullable: bool

Denotes whether this Field can be null

metadata: HashMap<String, MetadataValue>

A JSON map containing information about this column

Implementations

impl StructField

pub fn new( name: impl Into<String>, data_type: impl Into<DataType>, nullable: bool, ) -> StructField

Creates a new field

pub fn with_metadata( self, metadata: impl IntoIterator<Item = (impl Into<String>, impl Into<MetadataValue>)>, ) -> StructField

pub fn get_config_value( &self, key: &ColumnMetadataKey, ) -> Option<&MetadataValue>

pub fn physical_name( &self, mapping_mode: ColumnMappingMode, ) -> Result<&str, Error>

Get the physical name for this field as it should be read from parquet, based on the specified column mapping mode.

pub fn with_name(&self, new_name: impl Into<String>) -> StructField

Change the name of a field. The field will preserve its data type and nullability. Note that this allocates a new field.

pub fn name(&self) -> &String

pub fn is_nullable(&self) -> bool

pub const fn data_type(&self) -> &DataType

pub const fn metadata(&self) -> &HashMap<String, MetadataValue>

pub fn metadata_with_string_values(&self) -> HashMap<String, String>

Convert our metadata into a HashMap<String, String>. Note this copies all the data so can be expensive for large metadata

pub fn make_physical( &self, mapping_mode: ColumnMappingMode, ) -> Result<StructField, Error>

Trait Implementations

impl Clone for StructField

fn clone(&self) -> StructField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructField

fn deserialize<__D>( __deserializer: __D, ) -> Result<StructField, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructField

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Field> for StructField

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(arrow_field: &Field) -> Result<StructField, ArrowError>

Performs the conversion.

impl Eq for StructField

impl StructuralPartialEq for StructField