Struct StructType 

pub struct StructType(Arc<StructTypeInner>);

A cheaply cloneable struct type.

Tuple Fields

0: Arc<StructTypeInner>

Implementations

impl StructType

pub fn new( named_fields: impl IntoIterator<Item = (impl Into<String>, DataType)>, ) -> Self

Creates a struct type with named fields.

pub fn unnamed(fields: impl IntoIterator<Item = DataType>) -> Self

Creates a struct type with unnamed fields. The names will be assigned f1, f2, etc.

pub fn row_expr_type(fields: impl IntoIterator<Item = DataType>) -> Self

Creates a struct type for ROW expression with unnamed fields.

pub fn with_ids(self, ids: impl IntoIterator<Item = ColumnId>) -> Self

Attaches given field ids to the struct type.

Note that for empty struct, this method is a no-op, as StructType::ids will always return Some(<empty>) for empty struct.

pub fn has_ids(&self) -> bool

Whether the struct type has field ids. An empty struct is considered to have ids.

Note that this does not recursively check whether composite fields have ids.

pub fn is_unnamed(&self) -> bool

Whether the fields are unnamed.

pub fn len(&self) -> usize

Returns the number of fields.

pub fn is_empty(&self) -> bool

Returns true if there are no fields.

pub fn names(&self) -> impl ExactSizeIterator<Item = &str>

Gets an iterator over the names of the fields.

If fields are unnamed, the field names will be f1, f2, etc.

pub fn types(&self) -> impl ExactSizeIterator<Item = &DataType>

Gets an iterator over the types of the fields.

pub fn type_at(&self, index: usize) -> &DataType

Gets the type of a field by index.

pub fn iter(&self) -> impl ExactSizeIterator<Item = (&str, &DataType)>

Gets an iterator over the fields.

If fields are unnamed, the field names will be f1, f2, etc.

pub fn ids(&self) -> Option<impl ExactSizeIterator<Item = ColumnId> + '_>

Gets an iterator over the field ids.

Returns None if they are not present. See documentation on the field field_ids for the cases. For empty struct, this returns Some(<empty>).

pub fn id_at(&self, index: usize) -> Option<ColumnId>

Gets the field id at the given index.

Returns None if they are not present. See documentation on the field field_ids for the cases.

pub fn ids_or_placeholder(&self) -> impl ExactSizeIterator<Item = ColumnId> + '_

Get an iterator over the field ids, or a sequence of placeholder ids if they are not present.

pub fn equals_datatype(&self, other: &StructType) -> bool

Compares the datatype with another, ignoring nested field names and ids.

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 DataTypes for StructType

fn iter(&self) -> impl ExactSizeIterator<Item = &DataType>

fn at(&self, index: usize) -> &DataType

impl Debug for StructType

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

Formats the value using the given formatter.

impl Display for StructType

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

Formats the value using the given formatter.

impl From<&StructType> for Schema

fn from(t: &StructType) -> Self

Converts to this type from the input type.

impl From<StructType> for DataType

fn from(value: StructType) -> Self

Converts to this type from the input type.

impl FromStr for StructType

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for StructType

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

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 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 Eq for StructType

impl StructuralPartialEq for StructType