Struct StructType 

pub struct StructType { /* private fields */ }

DataType for a specific struct

Implementations

impl StructType

pub fn new(fields: Vec<StructField>) -> Self

Creates a new StructType with the given fields

Arguments

• fields - Vector of StructField that define the structure

The method automatically builds a lookup table mapping field IDs to their position in the fields vector for efficient field access by ID.

pub fn builder() -> StructTypeBuilder

Creates a new StructTypeBuilder to construct a StructType using the builder pattern

This is the recommended way to construct complex StructType instances when you need to add fields incrementally or conditionally.

pub fn get(&self, index: usize) -> Option<&StructField>

Gets a reference to the StructField at the given index

Arguments

• index - The index of the field to retrieve

Returns

• Some(&StructField) if a field exists at that index
• None if no field exists at that index

pub fn get_name(&self, name: &str) -> Option<&StructField>

Gets a reference to the StructField with the given name

Arguments

• name - The name of the field to retrieve

Returns

• Some(&StructField) if a field with the given name exists
• None if no field with that name exists

pub fn len(&self) -> usize

Returns the number of fields in this struct

Returns

• The total count of StructFields contained in this struct

pub fn is_empty(&self) -> bool

Returns true if the struct contains no fields

Returns

• true if this struct has no fields
• false if this struct has at least one field

pub fn iter(&self) -> Iter<'_, StructField>

Returns an iterator over all fields in this struct

Returns

• An iterator yielding references to each StructField in order

pub fn field_ids(&self) -> impl Iterator<Item = i32>

Returns an iterator over all field IDs in this struct, sorted in ascending order

Returns

• An iterator yielding field IDs (i32) in sorted order

pub fn primitive_field_ids(&self) -> impl Iterator<Item = i32>

Returns an iterator over field IDs of primitive-type fields only, sorted in ascending order

This method filters the struct’s fields to return only those with primitive types (boolean, numeric, string, etc.), excluding complex types like structs, lists, and maps.

Returns

• An iterator yielding field IDs (i32) of primitive fields in sorted order

Trait Implementations

impl Clone for StructType

fn clone(&self) -> StructType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructType

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<usize> for StructType

type Output = StructField

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for StructType

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Fields> for StructType

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Fields) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Schema> for StructType

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &ArrowSchema) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<Fields> for &StructType

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Fields, Self::Error>

Performs the conversion.

impl TryInto<Schema> for &StructType

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ArrowSchema, Self::Error>

Performs the conversion.

impl Eq for StructType

impl StructuralPartialEq for StructType