Struct StructPatchBuilder 

pub struct StructPatchBuilder<Item> { /* private fields */ }

Builds a sparse struct patch from a sequence of requested patch operations.

The builder records user intent, checks for conflicting destructive operations, and lowers nested field paths into recursive struct patches. The same builder surface drives both expression patching (ExpressionStructPatchBuilder) and schema patching (SchemaStructPatchBuilder); only the terminal build step differs.

Implementations

impl<Item> StructPatchBuilder<Item>

pub fn new() -> Self

Creates a new top-level patch builder.

pub fn new_nested(path: impl CollectInto<ColumnName>) -> Self

Creates a new builder that operates on fields of a nested struct identified by path.

pub fn drop(self, field_name: impl Into<String>) -> Self

Records a field drop.

pub fn drop_at( self, struct_path: impl CollectInto<ColumnName>, field_name: impl Into<String>, ) -> Self

Records a field drop in a nested struct.

pub fn drop_if_exists(self, field_name: impl Into<String>) -> Self

Records an optional field drop.

pub fn drop_if_exists_at( self, struct_path: impl CollectInto<ColumnName>, field_name: impl Into<String>, ) -> Self

Records an optional field drop in a nested struct.

pub fn replace( self, field_name: impl Into<String>, item: impl Into<Item>, ) -> Self

Records a field replacement.

pub fn replace_at( self, struct_path: impl CollectInto<ColumnName>, field_name: impl Into<String>, item: impl Into<Item>, ) -> Self

Records a field replacement in a nested struct.

pub fn prepend(self, item: impl Into<Item>) -> Self

Records an item to emit before processing the first input field.

pub fn prepend_at( self, struct_path: impl CollectInto<ColumnName>, item: impl Into<Item>, ) -> Self

Records an item to emit before processing the first input field of a nested struct.

pub fn insert_after( self, field_name: impl Into<String>, item: impl Into<Item>, ) -> Self

Records an item to insert after the named field.

pub fn insert_after_at( self, struct_path: impl CollectInto<ColumnName>, field_name: impl Into<String>, item: impl Into<Item>, ) -> Self

Records an item to insert after the named field in a nested struct.

pub fn append(self, item: impl Into<Item>) -> Self

Records an item to append after all input fields and field-specific insertions.

pub fn append_at( self, struct_path: impl CollectInto<ColumnName>, item: impl Into<Item>, ) -> Self

Records an item to append after all fields of a nested struct.

impl StructPatchBuilder<ExpressionRef>

pub fn build(self) -> DeltaResult<ExpressionStructPatch>

Builds the final expression patch.

Errors

Returns an error when builder calls request multiple drop/replace operations for the same field, or when a destructive operation on one field overlapped with an operation on a nested child field.

impl StructPatchBuilder<StructField>

pub fn build(self, input_schema: &StructType) -> DeltaResult<StructType>

Builds the output struct schema for this patch over input_schema.

If this builder targets a nested path (via new_nested), the returned schema is the patched schema for the nested struct at that path, not the full top-level input schema.

Errors

Returns an error if a builder call produced a conflicting operation, the input path cannot be resolved to a struct, a required field patch references a missing input field, a nested field patch targets a non-struct field, or the resulting output schema is invalid.

Trait Implementations

impl<Item: Debug> Debug for StructPatchBuilder<Item>

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

Formats the value using the given formatter.

impl TryFrom<StructPatchBuilder<Arc<Expression>>> for ExpressionStructPatch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(builder: StructPatchBuilder<ExpressionRef>) -> DeltaResult<Self>

Performs the conversion.