Struct deltalake::kernel::models::StructField

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

Represents a struct field defined in the Delta table schema.

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

Creates a new field with metadata

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

Get the value of a specific metadata key

pub fn name(&self) -> &String

Returns the name of the column

pub fn is_nullable(&self) -> bool

Returns whether the column is nullable

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

Returns the physical name of the column Equals the name if column mapping is not enabled on table

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

Returns the data type of the column

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

Returns the metadata of the column

Trait Implementations

impl Borrow<str> for StructField

fn borrow(&self) -> &str

Immutably borrows from an owned value.

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<'a> FromIterator<&'a StructField> for StructType

fn from_iter<T>(iter: T) -> StructType

where T: IntoIterator<Item = &'a StructField>,

Creates a value from an iterator.

impl FromIterator<StructField> for StructType

fn from_iter<T>(iter: T) -> StructType

where T: IntoIterator<Item = StructField>,

Creates a value from an iterator.

impl Hash for StructField

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StructField

fn eq(&self, other: &StructField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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 TryFrom<&StructField> for Field

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StructField

impl StructuralPartialEq for StructField