Skip to main content

StructType

Struct StructType 

Source
pub struct StructType { /* private fields */ }
Expand description

A struct is used to represent both the top-level schema of the table as well as struct columns that contain nested columns.

Implementations§

Source§

impl StructType

Source

pub fn try_new( fields: impl IntoIterator<Item = StructField>, ) -> DeltaResult<Self>

Creates a new StructType from the given fields.

Returns an error if:

  • the schema contains duplicate field names (case-insensitive; Delta column names are case-insensitive per the protocol)
  • the schema contains duplicate metadata columns
  • the schema contains nested metadata columns
Source

pub fn try_from_results<E: Into<Error>>( fields: impl IntoIterator<Item = Result<StructField, E>>, ) -> DeltaResult<Self>

Creates a new StructType from a fallible iterator of fields.

This constructor collects all fields from the iterator, returning the first error encountered, or a new StructType if all fields are successfully collected and validated.

Source

pub fn builder() -> StructTypeBuilder

Source

pub fn new_unchecked(fields: impl IntoIterator<Item = StructField>) -> Self

Available on crate feature internal-api only.

Creates a new StructType from the given fields without validating them.

This should only be used when you are sure that the fields are valid. Refer to StructType::try_new for more details on the validation checks.

Source

pub fn project_as_struct( &self, names: &[impl AsRef<str>], ) -> DeltaResult<StructType>

Gets a StructType containing StructFields of the given names. The order of fields in the returned schema will match the order passed to this function, which can be different from this order in this schema. Returns an Err if a specified field doesn’t exist.

Source

pub fn project(&self, names: &[impl AsRef<str>]) -> DeltaResult<SchemaRef>

Gets a SchemaRef containing StructFields of the given names. The order of fields in the returned schema will match the order passed to this function, which can be different from this order in this schema. Returns an Err if a specified field doesn’t exist.

Source

pub fn add( &self, fields: impl IntoIterator<Item = StructField>, ) -> DeltaResult<Self>

Adds fields to this StructType, returning a new StructType.

Source

pub fn add_metadata_column( &self, name: impl Into<String>, spec: MetadataColumnSpec, ) -> DeltaResult<Self>

Adds a predefined metadata column to this StructType, returning a new StructType.

Source

pub fn index_of(&self, name: impl AsRef<str>) -> Option<usize>

Returns the index of the field with the given name, or None if not found.

Source

pub fn index_of_metadata_column( &self, spec: &MetadataColumnSpec, ) -> Option<&usize>

Returns the index of the metadata column with the given spec, or None if not found.

Source

pub fn contains(&self, name: impl AsRef<str>) -> bool

Checks if the StructType contains a field with the specified name.

Source

pub fn contains_metadata_column(&self, spec: &MetadataColumnSpec) -> bool

Checks if the StructType contains a metadata column with the given spec.

Source

pub fn field(&self, name: impl AsRef<str>) -> Option<&StructField>

Gets the field with the given name.

Source

pub fn field_at<'a>(&'a self, col: &ColumnName) -> DeltaResult<&'a StructField>

Retrieves the nested field named by the given column path.

Returns an error if the path is empty, a field is not found, or an intermediate field is not a struct type.

Source

pub fn contains_col(&self, col: impl CollectInto<ColumnName>) -> bool

Checks whether this schema contains the field at the given column path.

Source

pub fn visit_fields_of_path<'a>( &'a self, col: &ColumnName, visit_field: impl FnMut(&'a StructField), ) -> DeltaResult<()>

Available on crate feature internal-api only.

Visits all fields along the given column path.

Returns an error if the path is empty, a field is not found, or an intermediate field is not a struct type.

Source

pub fn fields_of_path<'a>( &'a self, col: &ColumnName, ) -> DeltaResult<Vec<&'a StructField>>

Available on crate feature internal-api only.

Resolves a column path through nested structs, returning references to all StructFields along the path. The last element is the leaf field.

Each element of the path must resolve to a field in the current struct. All intermediate (non-leaf) fields must be struct types.

Returns an error if the path is empty, a field is not found, or an intermediate field is not a struct type.

Source

pub fn field_with_index( &self, name: impl AsRef<str>, ) -> Option<(usize, &StructField)>

Gets the field with the given name and its index.

Source

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

Gets the field at the given index.

Source

pub fn fields( &self, ) -> impl ExactSizeIterator<Item = &StructField> + DoubleEndedIterator + FusedIterator

Gets a reference to all the fields in this struct type.

Source

pub fn into_fields( self, ) -> impl ExactSizeIterator<Item = StructField> + DoubleEndedIterator + FusedIterator

Gets an iterator over all the fields in this struct type.

Source

pub fn field_at_path<'a>(&'a self, path: &[String]) -> &'a StructField

Available on crate features test-utils only.

Walk a pre-segmented column path through this schema and return the leaf field.

path is the path’s individual name segments (one per nesting level), already split by the caller. Lookup at each level is case-insensitive. The Delta protocol uses . as the dotted-path separator at the API surface, but field_at_path itself does not split – callers typically pass ColumnName::path(), which yields the segments directly.

Panics if any segment is missing or an intermediate field is not a struct. Intended for use in test assertions.

§Example
ⓘ
// Schema:
//   id:      INTEGER  not null
//   address: STRUCT { city: STRING not null, zip: STRING }
let path = vec!["address".to_string(), "city".to_string()];
let city = schema.field_at_path(&path);
assert_eq!(city.name(), "city");
assert!(!city.is_nullable());
Source

pub fn field_names(&self) -> impl ExactSizeIterator<Item = &String>

Gets all the field names in this struct type in the order they are defined.

Source

pub fn num_fields(&self) -> usize

Gets the number of fields in this struct type.

Source

pub fn total_struct_fields(&self) -> usize

Available on crate feature internal-api only.

Recursively counts all StructField nodes in this schema tree.

This includes nested struct fields (inside Struct, Array, and Map types) but does not count Array/Map containers themselves. This matches the traversal pattern used by assign_column_mapping_metadata when assigning column IDs, so the result equals the expected delta.columnMapping.maxColumnId for a newly created table.

Source

pub fn metadata_column(&self, spec: &MetadataColumnSpec) -> Option<&StructField>

Gets a reference to the metadata column with the given spec.

Source

pub fn metadata_columns(&self) -> impl Iterator<Item = &StructField>

Gets an iterator over all the metadata columns in this struct type.

Source

pub fn leaves<'s>( &self, own_name: impl Into<Option<&'s str>>, ) -> ColumnNamesAndTypes

Available on crate feature internal-api only.

Extracts the name and type of all leaf columns, in schema order. Caller should pass Some own_name if this schema is embedded in a larger struct (e.g. add.*) and None if the schema is a top-level result (e.g. *).

NOTE: This method only traverses through StructType fields; MapType and ArrayType fields are considered leaves even if they contain StructType entries/elements.

Source

pub fn make_physical( &self, column_mapping_mode: ColumnMappingMode, ) -> DeltaResult<Self>

Available on crate feature internal-api only.

Applies physical name mappings to this field. If the column_mapping_mode is ColumnMappingMode::Id, then each StructField will have its parquet field id in the ColumnMetadataKey::ParquetFieldId metadata field.

Uses a single transformer so duplicate column mapping IDs are detected across all fields in this struct, not just within each field’s subtree.

Source

pub fn with_fields_filtered( &self, predicate: impl Fn(&StructField) -> bool, ) -> DeltaResult<Self>

Returns a new StructType containing only the top-level fields for which predicate returns true. This does not recurse into nested StructType fields.

Source

pub fn with_fields_filtered_nonempty( &self, predicate: impl Fn(&StructField) -> bool, ) -> DeltaResult<Option<Self>>

Returns an optional StructType containing only the top-level fields for which predicate returns true.

This is a convenience wrapper around StructType::with_fields_filtered for callers that treat an empty top-level struct as “no schema”.

Trait Implementations§

Source§

impl Clone for StructType

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StructType

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>, Self: Sized,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for StructType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for StructType

Source§

impl From<&StructType> for StructType

Available on crate feature declarative-plans only.
Source§

fn from(struct_type: &StructType) -> Self

Converts to this type from the input type.
Source§

impl From<StructType> for DataType

Source§

fn from(struct_type: StructType) -> Self

Converts to this type from the input type.
Source§

impl IntoIterator for StructType

Source§

type Item = StructField

The type of the elements being iterated over.
Source§

type IntoIter = StructFieldIntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a> IntoIterator for &'a StructType

Source§

type Item = &'a StructField

The type of the elements being iterated over.
Source§

type IntoIter = StructFieldRefIter<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for StructType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for StructType

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StructType

Source§

impl TryFrom<StructType> for StructType

Available on crate feature declarative-plans only.
Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(proto: StructType) -> DeltaResult<Self>

Performs the conversion.
Source§

impl TryFromArrow<&Schema> for StructType

Available on crate feature arrow-conversion and (crate features arrow-conversion or declarative-plans or default-engine-base) only.
Source§

impl TryFromArrow<Arc<Schema>> for StructType

Available on crate feature arrow-conversion and (crate features arrow-conversion or declarative-plans or default-engine-base) only.
Source§

impl TryFromKernel<&StructType> for Schema

Available on crate feature arrow-conversion and (crate features arrow-conversion or declarative-plans or default-engine-base) only.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: Any + Send + Sync,

Source§

fn any_ref(&self) -> &(dyn Any + Sync + Send + 'static)

Obtains a dyn Any reference to the object: Read more
Source§

fn as_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Obtains an Arc<dyn Any> reference to the object: Read more
Source§

fn into_any(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts the object to Box<dyn Any>: Read more
Source§

fn type_name(&self) -> &'static str

Convenient wrapper for std::any::type_name, since Any does not provide it and Any::type_id is useless as a debugging aid (its Debug is just a mess of hex digits).
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<I, T> CollectInto<T> for I

Source§

fn collect_into(self) -> T

Available on crate feature internal-api only.
Collects this iterable into a T
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynPartialEq for T
where T: PartialEq + AsAny,

Source§

fn dyn_eq(&self, other: &(dyn Any + 'static)) -> bool

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> FoldWithOption for T

Source§

fn fold_with<U>(self, opt: Option<U>, f: impl FnOnce(Self, U) -> Self) -> Self

Available on crate feature internal-api only.
Applies an optional fold operation f to self if opt is Some; otherwise returns self unchanged. Read more
Source§

fn try_fold_with<U, E>( self, opt: Option<U>, f: impl FnOnce(Self, U) -> Result<Self, E>, ) -> Result<Self, E>

Available on crate feature internal-api only.
Fallible fold_with: applies Result-returning f to self if opt is Some, otherwise returns self unchanged (wrapped in Ok).
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<KernelType, ArrowType> TryIntoArrow<ArrowType> for KernelType
where ArrowType: TryFromKernel<KernelType>,

Source§

fn try_into_arrow(self) -> Result<ArrowType, ArrowError>

Available on crate feature arrow-conversion and (crate features arrow-conversion or declarative-plans or default-engine-base) only.
Source§

impl<KernelType, ArrowType> TryIntoKernel<KernelType> for ArrowType
where KernelType: TryFromArrow<ArrowType>,

Source§

fn try_into_kernel(self) -> Result<KernelType, ArrowError>

Available on crate feature arrow-conversion and (crate features arrow-conversion or declarative-plans or default-engine-base) only.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more